Amino::PtrDefaultFlag Struct Reference

Flag that may be passed when creating a Ptr, to make it contain a default value as its pointee. More...

#include <Ptr.h>

Detailed Description

Flag that may be passed when creating a Ptr, to make it contain a default value as its pointee.

This can be passed the Ptr constructor to create a Ptr to a default value for its pointee. The Ptr will therefore NOT be null when constructed with this flag. For example:

Amino::Ptr<MyClass> myClassPtr{Amino::PtrDefaultFlag{}};
// which is equivalent to:
Amino::Ptr<MyClass> myClassPtr{Amino::makeDefaultPtr<MyClass>()};
// Note that PtrDefaultFlag is convenient to avoid repetition of 'MyClass'

Warning

This can only be used on pointee types T that are "defaultable". That is, the type T is either:

• a custom user class that has specified a default value (using AMINO_DECLARE_DEFAULT_CLASS and AMINO_DEFINE_DEFAULT_CLASS (which is mandatory to use custom types in Amino graphs)) or,
• a type that is default constructible and is allowed to flow in Amino graph without providing the default value entry points) (for example Amino::Array types).

Definition at line 124 of file Ptr.h.