Command Struct Reference

Description:

A command of a ALib CLI command line.

Definition at line 639 of file arguments.hpp.

#include <arguments.hpp>

Inheritance diagram for Command:

Collaboration diagram for Command:

Public Field Index:
CommandDecl *	Declaration = nullptr
List< Parameter *, Recycling::Shared >	ParametersMandatory
List< Parameter *, Recycling::Shared >	ParametersOptional
Public Field Index: inherited from Parsed
CommandLine *	CmdLine
integer	Position
integer	QtyArgsConsumed

Public Method Index:
	Command (CommandLine *cmdLine)
ALIB_API Parameter *	GetParsedParameter (const String &name)
ALIB_API String	GetParsedParameterArg (const String &name)
ALIB_API bool	Read (CommandDecl &decl)
Public Method Index: inherited from Parsed
	Parsed (CommandLine *cmdLine)

Field Details:

Declaration

CommandDecl* Declaration = nullptr

The underlying declaration.

Definition at line 642 of file arguments.hpp.

ParametersMandatory

List<Parameter*, Recycling::Shared> ParametersMandatory

Mandatory parameters parsed.

Definition at line 645 of file arguments.hpp.

ParametersOptional

List<Parameter*, Recycling::Shared> ParametersOptional

Optional parameters parsed.

Definition at line 648 of file arguments.hpp.

Constructor(s) / Destructor Details::

Command()

Command ( CommandLine * cmdLine )

inline

Constructor

Parameters

cmdLine

The command line instance.

Definition at line 606 of file commandline.hpp.

Method Details:

GetParsedParameter()

Parameter * GetParsedParameter

(

const String &

name

)

Searches in ParametersMandatory and ParametersOptional for parameter name .

Parameters

name	The declaration name of the parameter.

Returns

A pointer to the parameter, nullptr if parameter was not parsed.

Definition at line 185 of file arguments.cpp.

GetParsedParameterArg()

String GetParsedParameterArg

(

const String &

name

)

Searches in ParametersMandatory and ParametersOptional for parameter name and returns its (first) argument.

Parameters

name	The declaration name of the parameter.

Returns

The argument string, NullString() if parameter was not parsed if not given.

Definition at line 209 of file arguments.cpp.

Here is the call graph for this function:

Read()

bool Read

(

CommandDecl &

decl

)

Tries to read the object from the front of CommandLine::ArgsLeft .

Parameters

decl	The declaration used for reading.

Returns

The true on success, false otherwise.

Definition at line 140 of file arguments.cpp.

Here is the call graph for this function:

---

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

• arguments.hpp
• arguments.cpp
• commandline.hpp