![]() |
Murl Engine API
Version 2018.3
|
The enumeration parameter template class. More...
#include <murl_util_environment.h>
The enumeration parameter template class.
Public Member Functions | |
EnumParameter (ParameterType type, const String &longId, const String &shortId, const String &description, const Enum< EnumType > &enumClass, EnumType defaultValue) | |
The constructor. More... | |
virtual SInt32 | Process (SInt32 currentIndex, SInt32 argC, const char **argV) |
Overload of Parameter::Process() converting the mValue. More... | |
![]() | |
Parameter (ParameterType type, const String &longId, const String &shortId, const String &description, SInt32 skip, Bool isArray) | |
The constructor. More... | |
virtual | ~Parameter () |
The destructor. | |
Public Attributes | |
const Enum< EnumType > & | mEnum |
The enumeration string mapping class. More... | |
EnumType | mValue |
The processed argument value. More... | |
![]() | |
ParameterType | mType |
The parameter type. More... | |
String | mLongId |
The long parameter identifier string. More... | |
String | mShortId |
The short parameter identifier string. More... | |
String | mDescription |
The parameter description string. More... | |
Bool | mIsSet |
Flag if the parameter is set. More... | |
SInt32 | mSkip |
The number of arguments used by the parameter. More... | |
Bool | mIsArray |
Signature for parameter arrays. More... | |
Additional Inherited Members | |
![]() | |
typedef AutoPointer< Parameter > | AutoPtr |
Definition of the parameter auto pointer. | |
|
inline |
The constructor.
type | The type of the parameter. |
longId | The long parameter identifier string. |
shortId | The short parameter identifier string. |
description | The parameter description string. |
enumClass | The enumeration string mapping class. |
defaultValue | The default value. |
|
inlinevirtual |
Overload of Parameter::Process() converting the mValue.
currentIndex | The zero-based index to the current argument. |
argC | The number of arguments. |
argV | The argument string values. |
Reimplemented from Murl::Util::Environment::Parameter.
const Enum<EnumType>& Murl::Util::Environment::EnumParameter< EnumType >::mEnum |
The enumeration string mapping class.
EnumType Murl::Util::Environment::EnumParameter< EnumType >::mValue |
The processed argument value.