Generated on Tue Dec 16 12:50:03 2008 for BIU-2.2.0 by doxygen 1.5.1

biu::COption Class Reference

#include <OptionParser.hh>


Detailed Description

Parameter description for COptionParser

Author:
Martin Mann <mmann@informatik.uni-freiburg.de>

Definition at line 29 of file OptionParser.hh.

Public Types

enum  TYPES {
  STRING, CHAR, INT, FLOAT,
  DOUBLE, BOOL, TYPES_SIZE
}

Public Member Functions

 COption (std::string _option, bool _optional, int _retType, std::string _description, std::string _defaultValue=DEF_INIT)
 ~COption ()

Static Public Member Functions

static std::vector< std::string > initTypeNames ()

Data Fields

std::string defValue
std::string description
bool exist
std::string option
bool optional
int retType
std::string strValue

Static Public Attributes

static std::string DEF_INIT
static std::vector< std::string > TYPE_NAME


Member Enumeration Documentation

supported parameter types

Enumerator:
STRING 
CHAR 
INT 
FLOAT 
DOUBLE 
BOOL 
TYPES_SIZE 

Definition at line 44 of file OptionParser.hh.


Constructor & Destructor Documentation

biu::COption::COption ( std::string  _option,
bool  _optional,
int  _retType,
std::string  _description,
std::string  _defaultValue = DEF_INIT 
) [inline]

construction

Definition at line 63 of file OptionParser.hh.

biu::COption::~COption (  )  [inline]

Definition at line 73 of file OptionParser.hh.


Member Function Documentation

static std::vector<std::string> biu::COption::initTypeNames (  )  [inline, static]

inits the parameter names for help output

Definition at line 47 of file OptionParser.hh.


Field Documentation

std::string biu::COption::DEF_INIT [static]

Definition at line 33 of file OptionParser.hh.

the default value if optional

Definition at line 40 of file OptionParser.hh.

the help description

Definition at line 38 of file OptionParser.hh.

is true if the parameter was given

Definition at line 41 of file OptionParser.hh.

std::string biu::COption::option

the parameter

Definition at line 35 of file OptionParser.hh.

if optional in the list

Definition at line 36 of file OptionParser.hh.

the type of the parameter

Definition at line 37 of file OptionParser.hh.

the value if given

Definition at line 39 of file OptionParser.hh.

std::vector< std::string > biu::COption::TYPE_NAME [static]

a list of the type names

Definition at line 60 of file OptionParser.hh.


The documentation for this class was generated from the following files: