BitmaskParameter Class Reference
[Parameters]

BitmaskParameter parameter type. More...

#include <parameter.h>

Inherits GenericParameter.

Inheritance diagram for BitmaskParameter:

Inheritance graph
[legend]
Collaboration diagram for BitmaskParameter:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 BitmaskParameter (string aName, string aComment, string aDefault, string aValues)
 the constructor of any parameter allows to define the various parameter attributes.
int get (string aClass, string aInstance)
 returns the parameter value.

Detailed Description

BitmaskParameter parameter type.

It stores Bitmasks; i.e., options that are not mutually exclusive.

example:

Param->addParameter ("fooClass", new BitmaskParameter("foo",  "foo desc.", "Linux+MacOSX", "Linux MacOSX Win" ));
int fooVal = get<BitmaskParameter,int>(Param, "foo", "fooClass", "");

Comments in this case are used. The various options must be separated by spaces. The parameter will return a number corresponding to the selected option(s). In the above case the return codes will mean:


Constructor & Destructor Documentation

BitmaskParameter::BitmaskParameter string  aName,
string  aComment,
string  aDefault,
string  aValues
 

the constructor of any parameter allows to define the various parameter attributes.

cippa lippa

Parameters:
aName name of the parameter. Spaces not allowed.
aComment a comment about the parameter
aDefault default value
aValues allowed values. Used, see above.


Member Function Documentation

int BitmaskParameter::get string  aClass,
string  aInstance
 

returns the parameter value.

Parameters:
aClass the class of the parameter.
aInstance The instance of the parameter


The documentation for this class was generated from the following file:
Generated on Wed Dec 22 23:23:48 2004 for NePSing by doxygen 1.3.9.1 ---- Hosted by SourceForge.net Logo