ALib C++ Library
Library Version: 2402 R1
Documentation generated by doxygen
No Matches
ERParameterDecl Struct Reference


ALib Enum Record type used by class ParameterDecl .

Definition at line 72 of file arguments.hpp.

#include <arguments.hpp>

Inheritance diagram for ERParameterDecl:
Collaboration diagram for ERParameterDecl:

Public Field Index:

String identifier
bool isOptional
int qtyExpectedArgsFollowing
nchar valueListSeparator
String valueSeparator
- Public Field Index: inherited from ERSerializable
String EnumElementName
int MinimumRecognitionLength

Public Method Index:

 ERParameterDecl () noexcept=default
ALIB_API void Parse ()
- Public Method Index: inherited from ERSerializable
 ERSerializable () noexcept=default
 ERSerializable (const String &name, int minLength=0) noexcept
ALIB_API void Parse ()

Field Details:

◆ identifier

String identifier

The identifier of the parameter.

Definition at line 75 of file arguments.hpp.

◆ isOptional

bool isOptional

Denotes if this is an optional parameter.

Definition at line 93 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 90 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 84 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 79 of file arguments.hpp.

Constructor(s) / Destructor Details::

◆ ERParameterDecl()

ERParameterDecl ( )

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

Method Details:

◆ Parse()

void Parse ( )

Implementation of EnumRecordPrototype::Parse .

Definition at line 295 of file arguments.cpp.

Here is the call graph for this function:

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