Description:

A declaration for a Parameter.

Definition at line 181 of file arguments.inl.

Inheritance diagram for alib::cli::Parameter:

Public Field Index:
ListMA< String, Recycling::Shared >	Args
	Arguments belonging to us.
ParameterDecl *	Declaration = nullptr
	The underlying declaration.
Public Field Index: inherited from alib::cli::Parsed
CommandLine *	CmdLine
	The cli command-line.
integer	ConsumedArguments
integer	Position

Public Method Index:
	Parameter (CommandLine *cmdLine)
bool	Read (ParameterDecl &decl)
Public Method Index: inherited from alib::cli::Parsed
	Parsed (CommandLine *cmdLine)

Field Details:

ListMA<String, Recycling::Shared> alib::cli::Parameter::Args

Arguments belonging to us.

Definition at line 187 of file arguments.inl.

ParameterDecl* alib::cli::Parameter::Declaration = nullptr

The underlying declaration.

Definition at line 184 of file arguments.inl.

alib::cli::Parameter::Parameter ( CommandLine * cmdLine )

inline

Constructor

Parameters

cmdLine The command-line instance.

Definition at line 504 of file commandline.inl.

bool alib::cli::Parameter::Read ( ParameterDecl & decl )

Tries to read the object from the front of StdVectorMA< integer > ArgsLeft. Success is indicated by setting inherited fields integer Position and integer ConsumedArguments to values greater than 0.

If it could not be decided if the actual CLI argument contains this parameter, false is returned to indicate that parsing commands has to stop now.

This is done in the following cases:

When const String & Identifier() is empty and the parameter is bool IsOptional() gives true.
When it was successfully read, but int QtyExpectedArgsFollowing() is defined -1.

Parameters

decl	The declaration used for reading

Returns: The true on success, false indicates that parsing has to end here.

Definition at line 203 of file arguments.cpp.

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