Murl::Util::Environment::EnumParameter< EnumType > Class Template Reference

The enumeration parameter template class. More...

#include "murl_util_environment.h"

Inheritance diagram for Murl::Util::Environment::EnumParameter< EnumType >:

Public Member Functions

 EnumParameter (ParameterType type, const String &longId, const String &shortId, const String &description, const Enum< EnumType > &enumClass, EnumType defaultValue)
 The constructor. More...
SInt32 Process (SInt32 currentIndex, SInt32 argC, const char **argV) override
 Overload of Parameter::Process() converting the mValue. 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

const Enum< EnumType > & mEnum
 The enumeration string mapping class.
EnumType mValue
 The processed argument value.
- 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

template<class EnumType>
class Murl::Util::Environment::EnumParameter< EnumType >

The enumeration parameter template class.

Constructor & Destructor Documentation

◆ EnumParameter()

template<class EnumType >
Murl::Util::Environment::EnumParameter< EnumType >::EnumParameter ( ParameterType  type,
const String longId,
const String shortId,
const String description,
const Enum< EnumType > &  enumClass,
EnumType  defaultValue 

The constructor.

typeThe type of the parameter.
longIdThe long parameter identifier string.
shortIdThe short parameter identifier string.
descriptionThe parameter description string.
enumClassThe enumeration string mapping class.
defaultValueThe default value.

Member Function Documentation

◆ Process()

template<class EnumType >
SInt32 Murl::Util::Environment::EnumParameter< EnumType >::Process ( SInt32  currentIndex,
SInt32  argC,
const char **  argV 

Overload of Parameter::Process() converting the mValue.

currentIndexThe zero-based index to the current argument.
argCThe number of arguments.
argVThe argument string values.
The number of arguments processed or -1 if parsing the argument failed.

Reimplemented from Murl::Util::Environment::Parameter.

References Murl::Util::Environment::EnumParameter< EnumType >::mEnum, Murl::Util::Environment::EnumParameter< EnumType >::mValue, Murl::System::Console::Print(), and Murl::Util::Environment::Parameter::Process().

The documentation for this class was generated from the following file:
  • murl_util_environment.h

Copyright © 2011-2022 Spraylight GmbH.