Description:

A declaration for a cli::Parameter .

Definition at line 256 of file arguments.hpp.

Inheritance diagram for Parameter:

Collaboration diagram for Parameter:

Public Field Index:
List< String, Recycling::Shared >	Args

ParameterDecl *	Declaration = nullptr

Public Field Index: inherited from Parsed
CommandLine *	CmdLine

integer	Position

integer	QtyArgsConsumed

Public Method Index:
	Parameter (CommandLine *cmdLine)

ALIB_API bool	Read (ParameterDecl &decl)

Public Method Index: inherited from Parsed
	Parsed (CommandLine *cmdLine)

Field Details:

Arguments belonging to us.

Definition at line 262 of file arguments.hpp.

ParameterDecl* Declaration = nullptr

The underlying declaration.

Definition at line 259 of file arguments.hpp.

Parameter ( CommandLine * cmdLine )

inline

Constructor

Parameters

cmdLine The command line instance.

Definition at line 583 of file commandline.hpp.

bool Read ( ParameterDecl & decl )

Tries to read the object from the front of CommandLine::ArgsLeft . Success is indicated by setting inherited fields Parsed::Position and Parsed::QtyArgsConsumed 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 ParameterDecl::Identifier is empty and the parameter is ParameterDecl::IsOptional gives true.
When it was successfully read, but ParameterDecl::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 217 of file arguments.cpp.

Here is the call graph for this function:

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