Parameter. More...
#include <rparam.h>
Inheritance diagram for RParam:
Collaboration diagram for RParam:
Public Member Functions | |
RParam (const RString &n, const RString &desc=RString::Null) | |
RString | GetName (void) const |
RString | GetDescription (void) const |
int | Compare (const RString &name) const |
int | Compare (const RParam ¶m) const |
virtual void | AddTag (RXMLStruct *xml, RXMLTag *parent) |
virtual bool | Set (RXMLTag *parent) |
virtual void | Reset (void) |
virtual | ~RParam (void) |
Protected Attributes | |
RString | Name |
RString | Description |
Detailed Description
Parameter.
The RParam class provides a representation for a parameter.
Constructor & Destructor Documentation
RParam | ( | const RString & | n, |
const RString & | desc = RString::Null |
||
) |
Constructor of the parameter.
- Parameters
-
n Name of the parameter. desc Description of the parameter.
|
virtual |
Destruct.
Member Function Documentation
RString GetName | ( | void | ) | const |
Get the name of the parameter.
RString GetDescription | ( | void | ) | const |
Get the description of the parameter.
int Compare | ( | const RString & | name | ) | const |
Compare the name of the parameter with a given string. This function is used by RContainer.
- Parameters
-
name The string used for the comparison.
- Returns
- -1,0 or 1 if the parameter is greater, the same or lesser than the parameter.
int Compare | ( | const RParam & | param | ) | const |
Compare the names of two parameters. This function is used by RContainer.
- Parameters
-
param The parameter used for the comparison.
- Returns
- -1,0 or 1 if the parameter is greater, the same or lesser than the parameter.
|
virtual |
Add a tag representing the values of the parameter.
- Parameters
-
xml XML structure. parent Parent tag.
Reimplemented in RParamStruct, RParamList, and RParamValue.
|
virtual |
Set the parameter based on a tag.
- Parameters
-
parent Tag.
- Returns
- true if the tag correspond to the current parameter or false if not.
Reimplemented in RParamStruct, RParamList, and RParamValue.
|
virtual |
Reset the value of the parameter.
Reimplemented in RParamStruct, RParamList, and RParamValue.
Field Documentation
|
protected |
Name of the parameter.
|
protected |
Description of the parameter.