conf::Option Struct Reference

An option. More...

#include <conf.hh>

List of all members.

Public Member Functions

 Option ()
long get_int () const
 Return the integer value of the option.
float get_float () const
 Return the float value of the option.
double get_double () const
 Return the double value of the option.
const std::string & get_str () const
 Return the string of the option.
const char * get_c_str () const
 Return the string of the option.

Public Attributes

unsigned char short_name
 The short name used for command line.
std::string long_name
 The long name used also in configuration files.
std::string value
 The value parsed from command line or file.
bool required
 Is the option required.
bool needs_argument
 Does the option need an argument.
bool specified
 Has the user specified the option.
std::string help
 The help string of the option.
std::string name
 The name string of the option: "-h --help", for example.


Detailed Description

An option.


Constructor & Destructor Documentation

conf::Option::Option  )  [inline]
 


Member Function Documentation

const char * conf::Option::get_c_str  )  const
 

Return the string of the option.

double conf::Option::get_double  )  const
 

Return the double value of the option.

float conf::Option::get_float  )  const
 

Return the float value of the option.

long conf::Option::get_int  )  const
 

Return the integer value of the option.

const std::string & conf::Option::get_str  )  const
 

Return the string of the option.


Member Data Documentation

std::string conf::Option::help
 

The help string of the option.

std::string conf::Option::long_name
 

The long name used also in configuration files.

std::string conf::Option::name
 

The name string of the option: "-h --help", for example.

bool conf::Option::needs_argument
 

Does the option need an argument.

bool conf::Option::required
 

Is the option required.

unsigned char conf::Option::short_name
 

The short name used for command line.

bool conf::Option::specified
 

Has the user specified the option.

std::string conf::Option::value
 

The value parsed from command line or file.


The documentation for this struct was generated from the following files:
Generated on Mon Jan 8 15:51:04 2007 for bit by  doxygen 1.4.6