In file EO++.h:

class Param : public Arg

A param is a type of argument that must be followed by its associated value in the command line or takes a default value if doesn't appear in the command line

Inheritance:


Public Classes

enum valueType
Type of params

Public Methods

bool changed( void )
Returns true if the default value of the param has changed
Param(string _shortName="-h", string _longName="--help", string _default = "", valueType _valType= STRING, string _description="Shows this help", bool _required=false )
Construct an Param
Param(const Param& _param)
Copy constructor
bool required( void )
Returns if required or not
virtual Arg::argType type( void )
Returns the type of the argument
Param::valueType valType( void )
Returns the type of the param's value
const string& value( void )
Returns the value of the param
void value( const string& _value )
Sets a value for the param
virtual ~Param()
Virtual destructor is needed

Public

enum valueType
Type of params

Inherited from Arg:

Public Classes

enum argType

Public Methods

const string& description( void )
const string& longName( void )
const string& shortName( void )

Public

enum argType

Documentation

A param is a type of argument that must be followed by its associated value in the command line or takes a default value if doesn't appear in the command line
enum valueType
Type of params

Param(string _shortName="-h", string _longName="--help", string _default = "", valueType _valType= STRING, string _description="Shows this help", bool _required=false )
Construct an Param
Parameters:
_shortName - Short name of the argument
_longName - Long name of the argument
_default - The default value
_valueType - Type of the parameter ("integer","float","char" and so on)
_description - Description of the parameter. What is useful for.
_required - If it is a necessary parameter or not

Param(const Param& _param)
Copy constructor
Parameters:
_param - The source param.

virtual ~Param()
Virtual destructor is needed

virtual Arg::argType type( void )
Returns the type of the argument

void value( const string& _value )
Sets a value for the param
Parameters:
_value - The new value.

const string& value( void )
Returns the value of the param

bool required( void )
Returns if required or not

Param::valueType valType( void )
Returns the type of the param's value

bool changed( void )
Returns true if the default value of the param has changed


This class has no child classes.

alphabetic index hierarchy of classes


BinOp