Murl::Util::Environment::StringArrayParameter Class Reference
The string array parameter class. More...
#include "murl_util_environment.h"
Inheritance diagram for Murl::Util::Environment::StringArrayParameter:
Public Member Functions | |
StringArrayParameter (ParameterType type, const String &longId, const String &shortId, const String &description, const String &defaultValue) | |
The constructor taking a default value, see Parameter::Parameter(). More... | |
StringArrayParameter (ParameterType type, const String &longId, const String &shortId, const String &description) | |
The constructor, see Parameter::Parameter(). More... | |
SInt32 | Process (SInt32 currentIndex, SInt32 argC, const char **argV) override |
Overload of Parameter::Process() converting the mValue(s). More... | |
Public Member Functions inherited from Murl::Util::Environment::Parameter | |
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. | |
StringArray | mValue |
The processed argument values. | |
Public Attributes inherited from Murl::Util::Environment::Parameter | |
ParameterType | mType |
The parameter type. | |
String | mLongId |
The long parameter identifier string. | |
String | mShortId |
The short parameter identifier string. | |
String | mDescription |
The parameter description string. | |
Bool | mIsSet |
Flag if the parameter is set. | |
SInt32 | mSkip |
The number of arguments used by the parameter. | |
Bool | mIsArray |
Signature for parameter arrays. | |
Additional Inherited Members | |
Public Types inherited from Murl::Util::Environment::Parameter | |
using | AutoPtr = AutoPointer< Parameter > |
Definition of the parameter auto pointer. | |
Detailed Description
The string array parameter class.
The default value is replaced by the first argument processed.
Constructor & Destructor Documentation
◆ StringArrayParameter() [1/2]
Murl::Util::Environment::StringArrayParameter::StringArrayParameter | ( | ParameterType | type, |
const String & | longId, | ||
const String & | shortId, | ||
const String & | description, | ||
const String & | defaultValue | ||
) |
The constructor taking a default value, see Parameter::Parameter().
- Parameters
-
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.
◆ StringArrayParameter() [2/2]
Murl::Util::Environment::StringArrayParameter::StringArrayParameter | ( | ParameterType | type, |
const String & | longId, | ||
const String & | shortId, | ||
const String & | description | ||
) |
The constructor, see Parameter::Parameter().
- Parameters
-
type The type of the parameter. longId The long parameter identifier string. shortId The short parameter identifier string. description The parameter description string.
Member Function Documentation
◆ Process()
|
overridevirtual |
Overload of Parameter::Process() converting the mValue(s).
- Parameters
-
currentIndex The zero-based index to the current argument. argC The number of arguments. argV The argument string values.
- Returns
- The number of arguments processed or -1 if parsing the argument failed.
Reimplemented from Murl::Util::Environment::Parameter.
The documentation for this class was generated from the following file:
- murl_util_environment.h