StringParameter Class Reference
[Parameters]

String parameter type. More...

#include <parameter.h>

Inherits GenericParameter.

Inheritance diagram for StringParameter:

Inheritance graph
[legend]
Collaboration diagram for StringParameter:

Collaboration graph
[legend]
List of all members.

Public Member Functions

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

Detailed Description

String parameter type.

It stores Strings. Spaces are not allowed.

example:

Param->addParameter ("fooClass", new StringParameter("foo",  "foo desc.", "FooString", "(0,inf)" ));
string fooVal = get<StringParameter,string>(Param, "foo", "fooClass", "");


Constructor & Destructor Documentation

StringParameter::StringParameter string  aName,
string  aComment,
string  aDefault,
string  aValues
[inline]
 

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

Parameters:
aName name of the parameter. Spaces not allowed.
aComment a comment about the parameter
aDefault default value
aValues allowed values. Not checked at runtime.


Member Function Documentation

string StringParameter::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:50 2004 for NePSing by doxygen 1.3.9.1 ---- Hosted by SourceForge.net Logo