Template Class CEnumArgValue

• Defined in File cmdlnparser.h

Inheritance Relationships

Base Type

• public CArgValueImpl< TVarBase > (Template Class CArgValueImpl)

Class Documentation

template<typename TVarBase, typename TVar = TVarBase>
class CEnumArgValue : public CArgValueImpl<TVarBase>

Arguments of numeric type derived from CArgValueImpl<>.

Public Functions

inline CEnumArgValue(CArgumentDefT<TVarBase> &rArgumentDef)

Constructor.

Parameters:

rArgumentDef – [in] Reference to the command line argument definition.

inline void Parse(TVar &rtArgument, const std::string &rssValue) const

Parse the value from the string(override for assignment values)

Parameters:

• rtArgument – [in] Reference to the numeric argument.

• rssValue – [in] Reference to the string value to be assigned.

inline std::string GetArgumentOptionMarkup() const

Get the markup string for the integer.

Returns:

std::string Returns the markup string.

inline std::string GetOptionDetails(size_t nMaxStringLen)

Get the option details for the argument type. Overload in derived class.

Remark

The nMaxStringLen could be ignored if no other alignment is needed; the print function will align the words based on their whitespace.

Parameters:

nMaxStringLen – [in] The maximum length of the string in characters; after the length is reached a newline should be added.

Returns:

std::string Returns the option details (default empty).

inline std::string GetArgumentValueString(const TVar &rtArgument) const

Get the value of the variable.

Parameters:

rtArgument – [in] Reference to the argument.

Returns:

std::string Returns the value of the variable.