ParameterDecl Class Reference

Description:

A parameter of a CommandDecl.

Construction is done by passing a custom enum element of an enum type equipped with ALib Enum Records of type ERParameterDecl.

When bootstrapping ALib CLI, method CommandLine::DefineParameters has to be invoked for (each) enum type.

Definition at line 100 of file arguments.hpp.

#include <arguments.hpp>

Collaboration diagram for ParameterDecl:

Public Method Index:
template<typename TEnum >
	ParameterDecl (TEnum element)
const Enum &	Element () const
const String &	GetHelpTextLong ()
const String &	GetHelpTextShort ()
const String &	Identifier ()
bool	IsOptional ()
int	MinimumRecognitionLength ()
const String &	Name ()
int	QtyExpectedArgsFollowing ()
nchar	ValueListSeparator ()
const String &	ValueSeparator ()

Protected Field Index:
Enum	declElement
	The enumeration element given with construction.
ERParameterDecl	record
	A copy (!) of the enum record.
ResourceInfo	resourceInfo
	The resource information of the enumeration type given with construction.

Field Details:

declElement

Enum declElement

protected

The enumeration element given with construction.

Definition at line 104 of file arguments.hpp.

record

ERParameterDecl record

protected

A copy (!) of the enum record.

Definition at line 107 of file arguments.hpp.

resourceInfo

ResourceInfo resourceInfo

protected

The resource information of the enumeration type given with construction.

Definition at line 110 of file arguments.hpp.

Constructor(s) / Destructor Details:

ParameterDecl()

template<typename TEnum >

ParameterDecl ( TEnum element )

inline

Templated constructor which takes an enum element of a custom type equipped with ALib Enum Records of type ERParameterDecl.

Template Parameters

TEnum

C++ enum type equipped with corresponding ALib Enum Records.

Parameters

element

The enum element

Definition at line 119 of file arguments.hpp.

Here is the call graph for this function:

Method Details:

Element()

const Enum & Element ( ) const

inline

Returns the type and integral value of the enumeration element used with construction.

Returns

The enumeration element used with construction.

Definition at line 133 of file arguments.hpp.

GetHelpTextLong()

const String & GetHelpTextLong ( )

inline

Returns the long help text. Loads the string from resourceInfo using resource name "THelpParLngNN", where NN is the enum element's integral value.

Returns

The help text.

Definition at line 212 of file arguments.hpp.

Here is the call graph for this function:

GetHelpTextShort()

const String & GetHelpTextShort ( )

inline

Returns the short help text. Loads the string from resourceInfo using resource name "THelpParShtNN", where NN is the enum element's integral value.

Returns

The help text.

Definition at line 203 of file arguments.hpp.

Here is the call graph for this function:

Identifier()

const String & Identifier ( )

inline

Returns the identifier of the parameter. If this is empty, the parameter is not optional and hence has no identifier.

Returns

The name of the enum element.

Definition at line 153 of file arguments.hpp.

IsOptional()

bool IsOptional ( )

inline

Returns true if the parameter is optional. The information about this attribute is used to create help messages and usage format strings only. It does not automatically raise an exception if a parameter is not given. Such exception or other error treatment is up to the user code.

Returns

true if the parameter is optional, false otherwise.

Definition at line 194 of file arguments.hpp.

MinimumRecognitionLength()

int MinimumRecognitionLength ( )

inline

Returns the minimum parse length of the identifier.

Returns

The minimum characters to satisfy the parameter.

Definition at line 160 of file arguments.hpp.

Name()

const String & Name ( )

inline

Returns the name of the parameter. This is not the identifier. The name is just for help and configuration output.

See also

Method Identifier.

Returns

The name of the enum element.

Definition at line 144 of file arguments.hpp.

QtyExpectedArgsFollowing()

int QtyExpectedArgsFollowing ( )

inline

The number of CLI arguments to consume and store in Option::Args with method Parameter::Read.

Returns

The parameter identifier.

Definition at line 184 of file arguments.hpp.

ValueListSeparator()

nchar ValueListSeparator ( )

inline

A separator character for parsing multiple values.

Returns

The separator character.

Definition at line 175 of file arguments.hpp.

ValueSeparator()

const String & ValueSeparator ( )

inline

An optional separator string (usually "="), that separates the parameter name from a parameter value.

Returns

The separator string.

Definition at line 168 of file arguments.hpp.

---

The documentation for this class was generated from the following file:

• arguments.hpp