Description:

ALib Enum Record type used by class ParameterDecl.

Definition at line 52 of file arguments.inl.

Inheritance 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
void	Parse ()
	Implementation of void 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
void	Parse ()

Field Details:

◆ identifier

String alib::cli::ERParameterDecl::identifier

The identifier of the parameter.

Definition at line 54 of file arguments.inl.

◆ isOptional

bool alib::cli::ERParameterDecl::isOptional

Denotes if this is an optional parameter.

Definition at line 72 of file arguments.inl.

◆ RequiredArguments

int alib::cli::ERParameterDecl::RequiredArguments

The number of arguments to consume and store in ListMA< String, Recycling::Shared > 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 69 of file arguments.inl.

◆ valueListSeparator

nchar alib::cli::ERParameterDecl::valueListSeparator

A separator character for parsing multiple values. If set to 'C', method nchar ValueListSeparator() will return ',' instead.

Definition at line 63 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 58 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.)

Method Details:

◆ Parse()

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

Implementation of void Parse() .

Definition at line 272 of file arguments.cpp.

The documentation for this struct was generated from the following files: