Murl::Util::Environment::Parameter Class Reference

The parameter base class. More...

#include "murl_util_environment.h"

Inheritance diagram for Murl::Util::Environment::Parameter:

Public Types

typedef AutoPointer< ParameterAutoPtr
 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...

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.

typeThe type of the parameter.
longIdThe long parameter identifier string.
shortIdThe short parameter identifier string.
descriptionThe parameter description string.
skipThe number of arguments used by the parameter.
isArraytrue if the parameter implements an array.

Member Function Documentation

◆ Process()

virtual SInt32 Murl::Util::Environment::Parameter::Process ( SInt32  currentIndex,
SInt32  argC,
const char **  argV 

Member Data Documentation

◆ mType

ParameterType Murl::Util::Environment::Parameter::mType

The parameter type.

◆ mLongId

String Murl::Util::Environment::Parameter::mLongId

The long parameter identifier string.

◆ mShortId

String Murl::Util::Environment::Parameter::mShortId

The short parameter identifier string.

◆ mDescription

String Murl::Util::Environment::Parameter::mDescription

The parameter description string.

◆ mIsSet

Bool Murl::Util::Environment::Parameter::mIsSet

Flag if the parameter is set.

◆ mSkip

SInt32 Murl::Util::Environment::Parameter::mSkip

The number of arguments used by the parameter.

◆ mIsArray

Bool Murl::Util::Environment::Parameter::mIsArray

Signature for parameter arrays.

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

Copyright © 2011-2018 Spraylight GmbH.