Class Description

ALib Enum Record type used by class ParameterDecl.

Definition at line 73 of file arguments.hpp.

Public Fields
String	identifier

bool	isOptional

int	qtyExpectedArgsFollowing

nchar	valueListSeparator

String	valueSeparator

Public Fields inherited from ERSerializable
String	EnumElementName

int	MinimumRecognitionLength

Public Methods
	ERParameterDecl () noexcept=default

ALIB_API void	Parse ()

Public Methods inherited from ERSerializable
	ERSerializable () noexcept=default

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

ALIB_API void	Parse ()

Constructor & Destructor Documentation

◆ ERParameterDecl()

ERParameterDecl ( )

defaultnoexcept

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

Member Function Documentation

◆ Parse()

void Parse ( )

Implementation of EnumRecordPrototype::Parse.

Definition at line 295 of file arguments.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ identifier

String identifier

The identifier of the parameter.

Definition at line 76 of file arguments.hpp.

◆ isOptional

bool isOptional

Denotes if this is an optional parameter.

Definition at line 94 of file arguments.hpp.

◆ qtyExpectedArgsFollowing

int qtyExpectedArgsFollowing

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 91 of file arguments.hpp.

◆ valueListSeparator

nchar valueListSeparator

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

Definition at line 85 of file arguments.hpp.

◆ valueSeparator

String valueSeparator

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

Definition at line 80 of file arguments.hpp.

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