![]() |
Murl Engine API
Version 2018.3
|
The parameter base class. More...
#include <murl_util_environment.h>
The parameter base class.
Public Types | |
typedef AutoPointer< Parameter > | AutoPtr |
Definition of the parameter auto pointer. | |
Public Member Functions | |
Parameter (ParameterType type, const String &longId, const String &shortId, const String &description, SInt32 skip, Bool isArray) | |
The constructor. More... | |
virtual | ~Parameter () |
The destructor. | |
virtual SInt32 | Process (SInt32 currentIndex, SInt32 argC, const char **argV) |
Process the parameter's arguments. More... | |
Public Attributes | |
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... | |
Murl::Util::Environment::Parameter::Parameter | ( | ParameterType | type, |
const String & | longId, | ||
const String & | shortId, | ||
const String & | description, | ||
SInt32 | skip, | ||
Bool | isArray | ||
) |
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. |
skip | The number of arguments used by the parameter. |
isArray | true if the parameter implements an array. |
|
virtual |
Process the parameter's arguments.
currentIndex | The zero-based index to the current argument. |
argC | The number of arguments. |
argV | The argument string values. |
Reimplemented in Murl::Util::Environment::EnumArrayParameter< EnumType >, Murl::Util::Environment::EnumParameter< EnumType >, Murl::Util::Environment::SwitchParameter, Murl::Util::Environment::ColorParameter, Murl::Util::Environment::DoubleArrayParameter, Murl::Util::Environment::DoubleParameter, Murl::Util::Environment::SInt32ArrayParameter, Murl::Util::Environment::SInt32Parameter, Murl::Util::Environment::StringPairArrayParameter, Murl::Util::Environment::StringArrayParameter, and Murl::Util::Environment::StringParameter.
ParameterType Murl::Util::Environment::Parameter::mType |
The parameter type.
String Murl::Util::Environment::Parameter::mLongId |
The long parameter identifier string.
String Murl::Util::Environment::Parameter::mShortId |
The short parameter identifier string.
String Murl::Util::Environment::Parameter::mDescription |
The parameter description string.
Bool Murl::Util::Environment::Parameter::mIsSet |
Flag if the parameter is set.
SInt32 Murl::Util::Environment::Parameter::mSkip |
The number of arguments used by the parameter.
Bool Murl::Util::Environment::Parameter::mIsArray |
Signature for parameter arrays.