The parameter base class. More...
#include "murl_util_environment.h"
Public Types | |
| using | AutoPtr = AutoPointer< Parameter > |
| 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. | |
| 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. | |
Detailed Description
The parameter base class.
Constructor & Destructor Documentation
◆ Parameter()
| Murl::Util::Environment::Parameter::Parameter | ( | ParameterType | type, |
| const String & | longId, | ||
| const String & | shortId, | ||
| const String & | description, | ||
| SInt32 | skip, | ||
| Bool | isArray | ||
| ) |
The constructor.
- Parameters
-
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.
Member Function Documentation
◆ Process()
|
virtual |
Process the parameter's arguments.
- 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 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::StringListArrayParameter, Murl::Util::Environment::StringPairArrayParameter, Murl::Util::Environment::StringArrayParameter, and Murl::Util::Environment::StringParameter.
Referenced by Murl::Util::Environment::EnumParameter< EnumType >::Process(), and Murl::Util::Environment::EnumArrayParameter< EnumType >::Process().
The documentation for this class was generated from the following file:
- murl_util_environment.h