Template Class CEnumArgumentDefBase

• Defined in File cmdlnparser.h

Nested Relationships

Nested Types

• Struct CEnumArgumentDefBase::SEnumAssociation

Inheritance Relationships

Derived Types

• public CArgumentDefT< TEnum, typename std::enable_if_t< std::is_enum< TEnum >::value > > (Template Class CArgumentDefT< TEnum, typename std::enable_if_t< std::is_enum< TEnum >::value > >)

• public CArgumentDefT< sdv::sequence< TEnum >, typename std::enable_if_t< std::is_enum< TEnum >::value > > (Template Class CArgumentDefT< sdv::sequence< TEnum >, typename std::enable_if_t< std::is_enum< TEnum >::value > >)

• public CArgumentDefT< std::list< TEnum >, typename std::enable_if_t< std::is_enum< TEnum >::value > > (Template Class CArgumentDefT< std::list< TEnum >, typename std::enable_if_t< std::is_enum< TEnum >::value > >)

• public CArgumentDefT< std::vector< TEnum >, typename std::enable_if_t< std::is_enum< TEnum >::value > > (Template Class CArgumentDefT< std::vector< TEnum >, typename std::enable_if_t< std::is_enum< TEnum >::value > >)

Class Documentation

template<typename TEnum>
class CEnumArgumentDefBase

Argument implementation for enumerator argument specialization. This class is used for single and multiple enum arguments.

Subclassed by CArgumentDefT< TEnum, typename std::enable_if_t< std::is_enum< TEnum >::value > >, CArgumentDefT< sdv::sequence< TEnum >, typename std::enable_if_t< std::is_enum< TEnum >::value > >, CArgumentDefT< std::list< TEnum >, typename std::enable_if_t< std::is_enum< TEnum >::value > >, CArgumentDefT< std::vector< TEnum >, typename std::enable_if_t< std::is_enum< TEnum >::value > >

Public Functions

inline void AddAssociation(TEnum eEnumValue, const std::string &rssValueText, const std::string &rssDescription)

Add an enumerator association.

Parameters:

• eEnumValue – [in] The value of the enumerator.

• rssValueText – [in] The text belonging to the value. Cannot be NULL.

• rssDescription – [in] The description of the enumerator value. Can be NULL, which means that it will be the same as the value text.

inline void AddAssociation(const SEnumArgumentAssoc<TEnum> &rsAssociation)

Add an enumerator association.

Parameters:

rsAssociation – [in] Reference to an enumerator association structure.

template<size_t nSize>
inline void AddAssociations(const SEnumArgumentAssoc<TEnum> (&rgsAssociations)[nSize])

Add a array of enumerator associations.

Template Parameters:

nSize – Amount of associations in the array.

Parameters:

rgsAssociations – [in] Array of enumerator associations.

inline const std::list<SEnumAssociation> &GetAssociations() const

Return a reference to the the stored associations.

Returns:

std::list<SEnumAssociation>& Reference to the list of associations.

struct SEnumAssociation

Internal enumerator association structure.

Public Members

TEnum eValue

The value of the enumerator.

std::string ssValueText

The value in text.

std::string ssDescription

The description of the enumerator value.