Enum() [3/6]

template<typename LookupClass , typename EnumType >

drama::gitarg::Enum< LookupClass, EnumType >::Enum ( const sds::Id &  Id, const std::string &  Name, const int  Position, const std::string &  Default, const Flags  flags = Flags::Upper|Flags::Abbrev|Flags::KeepErr  )

inline

Constructor which constructs the value from an item in an SDS structure.

The value is fetched from the named item (arg #2) within the SDS structure specified. or the Position (constructor arg #3) item in the
structure if the item named does not exist.

Note

The DRAMA lock must be taken when executing this. If in a thread, the preference is to take it by constructing a drama::AccessDrama object to ensure the action context is correct. An alternative overload of this method will take the lock itself.

Deprecated:

A string as the default is no longer supported, You need to use an enum value as the default. The constructor will throw if you use default value which is not an empty string as behavior in that case is not defined. Status DRAMA2__GITARG_ENUM_INVDEF.

Parameters

Id	The SDS structure.
Name	The name of the item within the structure.
Position	If the item does not exist by the name, then presume this position.
Default	The default value. If specified as an empty string, then the first enum value will be used, otherwise will throw (as it is not implemented correctly and you should use the alternative method with an enum based default.)
flags	Which GIT Flags to apply. If you specify KeepErr, then an exception is thrown if the value in the SDS structure is invalid. If you don't specify KeepErr and and the SDS structure is invalid, then the enum value is set to the Invalid value.

References drama::CreateRunDramaTask(), drama::Default, and drama::gitarg::Enum< LookupClass, EnumType >::Get().