BLOCXX_NAMESPACE::CmdLineParser::Option Struct Reference

The Option structure is used to hold information about a single command line option. More...

#include <CmdLineParser.hpp>

List of all members.

Public Attributes

int id
 Unique option id, used to retrieve option values.
char shortopt
 Short option char.
const char * longopt
 Long option string.
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.
const char * description
 Description used by getUsage().


Detailed Description

The Option structure is used to hold information about a single command line option.

Definition at line 96 of file CmdLineParser.hpp.


Member Data Documentation

EArgumentTypeFlag BLOCXX_NAMESPACE::CmdLineParser::Option::argtype
 

Specifies constraints for the option's argument.

Definition at line 105 of file CmdLineParser.hpp.

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 110 of file CmdLineParser.hpp.

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

Description used by getUsage().

May be 0.

Definition at line 112 of file CmdLineParser.hpp.

int BLOCXX_NAMESPACE::CmdLineParser::Option::id
 

Unique option id, used to retrieve option values.

Definition at line 99 of file CmdLineParser.hpp.

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

Long option string.

Set to 0 for none.

Definition at line 103 of file CmdLineParser.hpp.

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

char BLOCXX_NAMESPACE::CmdLineParser::Option::shortopt
 

Short option char.

Set to '\0' for none.

Definition at line 101 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:
Generated on Fri Jun 16 15:39:10 2006 for blocxx by  doxygen 1.4.6