ALib C++ Library
Library Version: 2412 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
Parsed Struct Reference

Description:

Struct used as parent for types

Stores

  • a pointer to the CommandLine object,
  • the position in ARG_VN, respectively 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 31 of file arguments.hpp.

#include <arguments.hpp>

Inheritance diagram for Parsed:
[legend]
Collaboration diagram for Parsed:
[legend]

Public Field Index:

CommandLineCmdLine
 The cli command line.
 
integer ConsumedArguments
 
integer Position
 

Public Method Index:

 Parsed (CommandLine *cmdLine)
 

Field Details:

◆ CmdLine

CommandLine* CmdLine

The cli command line.

Definition at line 34 of file arguments.hpp.

◆ ConsumedArguments

integer 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 43 of file arguments.hpp.

◆ Position

integer Position

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

Definition at line 38 of file arguments.hpp.

Constructor(s) / Destructor Details:

◆ Parsed()

Parsed ( CommandLine * cmdLine)
inline

Constructor

Parameters
cmdLineThe command line instance.

Definition at line 47 of file arguments.hpp.


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