blocxx
BLOCXX_NAMESPACE::CmdLineParser::Option Struct Reference

#include <CmdLineParser.hpp>

Public Attributes

int id
 unique option id, used to retrieve option values
 
char shortopt
 short option char. Set to '\0' for none.
 
const char * longopt
 long option string. Set to 0 for none.
 
EArgumentTypeFlag argtype
 specifies constraints for the option's argument
 
const char * defaultValue
 if argtype == E_OPTIONAL_ARG and no argument is specified, this value will be returned. Set to 0 for none.
 
const char * description
 description used by getUsage(). May be 0.
 

Detailed Description

Definition at line 77 of file CmdLineParser.hpp.

Member Data Documentation

◆ argtype

EArgumentTypeFlag BLOCXX_NAMESPACE::CmdLineParser::Option::argtype

specifies constraints for the option's argument

Definition at line 82 of file CmdLineParser.hpp.

Referenced by BLOCXX_NAMESPACE::CmdLineParser::CmdLineParser().

◆ defaultValue

const char* BLOCXX_NAMESPACE::CmdLineParser::Option::defaultValue

if argtype == E_OPTIONAL_ARG and no argument is specified, this value will be returned. Set to 0 for none.

Definition at line 83 of file CmdLineParser.hpp.

Referenced by BLOCXX_NAMESPACE::CmdLineParser::CmdLineParser().

◆ description

const char* BLOCXX_NAMESPACE::CmdLineParser::Option::description

description used by getUsage(). May be 0.

Definition at line 84 of file CmdLineParser.hpp.

◆ id

int BLOCXX_NAMESPACE::CmdLineParser::Option::id

unique option id, used to retrieve option values

Definition at line 79 of file CmdLineParser.hpp.

Referenced by BLOCXX_NAMESPACE::CmdLineParser::CmdLineParser().

◆ longopt

const char* BLOCXX_NAMESPACE::CmdLineParser::Option::longopt

long option string. Set to 0 for none.

Definition at line 81 of file CmdLineParser.hpp.

Referenced by BLOCXX_NAMESPACE::CmdLineParserException::clone(), and BLOCXX_NAMESPACE::CmdLineParser::CmdLineParser().

◆ shortopt

char BLOCXX_NAMESPACE::CmdLineParser::Option::shortopt

short option char. Set to '\0' for none.

Definition at line 80 of file CmdLineParser.hpp.

Referenced by BLOCXX_NAMESPACE::CmdLineParser::CmdLineParser(), and BLOCXX_NAMESPACE::CmdLineParser::getUsage().


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