Description:

ALib Enum Record type used by class ParameterDecl.

Definition at line 53 of file arguments.inl.

Inheritance diagram for alib::cli::ERParameterDecl:

Collaboration diagram for alib::cli::ERParameterDecl:

Public Field Index:
String	identifier
	The identifier of the parameter.

bool	isOptional
	Denotes if this is an optional parameter.

int	RequiredArguments

nchar	valueListSeparator

String	valueSeparator

Public Field Index: inherited from alib::enumrecords::ERSerializable
String	EnumElementName
	The name of the enum element.

int	MinimumRecognitionLength

Public Method Index:
	ERParameterDecl () noexcept=default

ALIB_DLL void	Parse ()
	Implementation of EnumRecordPrototype::Parse.

Public Method Index: inherited from alib::enumrecords::ERSerializable
	ERSerializable () noexcept=default
	Defaulted constructor leaving the record undefined.

	ERSerializable (const String &name, int minLength=0) noexcept

ALIB_DLL void	Parse ()

Field Details:

◆ identifier

String alib::cli::ERParameterDecl::identifier

The identifier of the parameter.

Definition at line 56 of file arguments.inl.

◆ isOptional

bool alib::cli::ERParameterDecl::isOptional

Denotes if this is an optional parameter.

Definition at line 74 of file arguments.inl.

◆ RequiredArguments

int alib::cli::ERParameterDecl::RequiredArguments

The number of arguments to consume and store in Parameter::Args. If negative, parsing stops. If previous field, separator string is set and this value is equal or greater to 1, then a missing separator string leads to a parsing exception.

Definition at line 71 of file arguments.inl.

◆ valueListSeparator

nchar alib::cli::ERParameterDecl::valueListSeparator

A separator character for parsing multiple values. If set to 'C', method ParameterDecl::ValueListSeparator will return ',' instead.

Definition at line 65 of file arguments.inl.

◆ valueSeparator

String alib::cli::ERParameterDecl::valueSeparator

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

Definition at line 60 of file arguments.inl.

Constructor(s) / Destructor Details:

◆ ERParameterDecl()

alib::cli::ERParameterDecl::ERParameterDecl ( )

defaultnoexcept

Default constructor leaving the record undefined. (Implementation required as documented here.)

Here is the call graph for this function:

Method Details:

◆ Parse()

void alib::cli::ERParameterDecl::Parse ( )

Implementation of EnumRecordPrototype::Parse.

Definition at line 295 of file arguments.cpp.