Description:

Struct used as parent for types

Stores

a pointer to the CommandLine object,
the position in alib::ARG_VN, respectively alib::ARG_VW where the object was found, and
the number of arguments consumed when reading the object.

Note: For technical reasons, other members that are shared between the derived types named above, have to be declared (each three times) with the types themselves.

Definition at line 55 of file cliargtypes.hpp.

#include <cliargtypes.hpp>

Inheritance diagram for alib::app::Parsed:

[legend]

Collaboration diagram for alib::app::Parsed:

[legend]

Public Field Index:
CommandLine *	CmdLine
	The cli command-line.
integer	ConsumedArguments
integer	Position

Public Method Index:
	Parsed (CommandLine *cmdLine)

Field Details:

◆ CmdLine

CommandLine* alib::app::Parsed::CmdLine

The cli command-line.

Definition at line 57 of file cliargtypes.hpp.

◆ ConsumedArguments

integer alib::app::Parsed::ConsumedArguments

The number of command-line arguments that a command consumed. This includes the command name itself. If the method Read of derived types leaves this to 0, then the option or parameter was not found.

Definition at line 66 of file cliargtypes.hpp.

◆ Position

integer alib::app::Parsed::Position

The index in ARG_VN, respectively alib::ARG_VW, that this instance (derived option or parameter) was found at.

Definition at line 61 of file cliargtypes.hpp.

Constructor(s) / Destructor Details:

◆ Parsed()

alib::app::Parsed::Parsed ( CommandLine * cmdLine )

inline

Constructor

Parameters

cmdLine The command-line instance.

Definition at line 70 of file cliargtypes.hpp.

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

cliargtypes.hpp