![]() |
Murl Engine API
Version 2018.3
|
The integer array parameter class. More...
#include <murl_util_environment.h>
The integer array parameter class.
The default value is replaced by the first argument processed.
Public Member Functions | |
SInt32ArrayParameter (ParameterType type, const String &longId, const String &shortId, const String &description, SInt32 defaultValue) | |
The constructor taking a default value, see Parameter::Parameter(). More... | |
SInt32ArrayParameter (ParameterType type, const String &longId, const String &shortId, const String &description) | |
The constructor, see Parameter::Parameter(). More... | |
virtual SInt32 | Process (SInt32 currentIndex, SInt32 argC, const char **argV) |
Overload of Parameter::Process() converting the mValue(s). 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 | |
Bool | mHasDefaultValue |
Flag if mValue array has a default value set. More... | |
SInt32Array | mValue |
The processed argument values. 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. | |
Murl::Util::Environment::SInt32ArrayParameter::SInt32ArrayParameter | ( | ParameterType | type, |
const String & | longId, | ||
const String & | shortId, | ||
const String & | description, | ||
SInt32 | defaultValue | ||
) |
The constructor taking a default value, see Parameter::Parameter().
type | The type of the parameter. |
longId | The long parameter identifier string. |
shortId | The short parameter identifier string. |
description | The parameter description string. |
defaultValue | The default value. |
Murl::Util::Environment::SInt32ArrayParameter::SInt32ArrayParameter | ( | ParameterType | type, |
const String & | longId, | ||
const String & | shortId, | ||
const String & | description | ||
) |
The constructor, see Parameter::Parameter().
type | The type of the parameter. |
longId | The long parameter identifier string. |
shortId | The short parameter identifier string. |
description | The parameter description string. |
|
virtual |
Overload of Parameter::Process() converting the mValue(s).
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.
Bool Murl::Util::Environment::SInt32ArrayParameter::mHasDefaultValue |
Flag if mValue array has a default value set.
SInt32Array Murl::Util::Environment::SInt32ArrayParameter::mValue |
The processed argument values.