Structure of Parameters. More...
#include <rparam.h>
Inheritance diagram for RParamStruct:
Collaboration diagram for RParamStruct:
Public Member Functions | |
RParamStruct (const RXMLTag *tag) | |
RParamStruct (const RString &name, const RString &desc=RString::Null) | |
RCursor< RParam > | GetStruct (void) const |
virtual bool | Set (RXMLTag *parent) |
void | Insert (RParam *param) |
template<class T > | |
T * | Get (const RString &name) const |
virtual void | AddTag (RXMLStruct *xml, RXMLTag *parent) |
virtual void | Reset (void) |
Public Member Functions inherited from RParam | |
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 | ~RParam (void) |
Private Attributes | |
RContainer< RParam, true, true > | Parameters |
Additional Inherited Members | |
Protected Attributes inherited from RParam | |
RString | Name |
RString | Description |
Detailed Description
Structure of Parameters.
The RParamStruct class provides a representation for a structure of multiple parameters.
Constructor & Destructor Documentation
RParamStruct | ( | const RXMLTag * | tag | ) |
Constructor of the parameter.
- Parameters
-
tag Tag.
RParamStruct | ( | const RString & | name, |
const RString & | desc = RString::Null |
||
) |
Constructor of the parameter.
- Parameters
-
name Name. desc Description of the parameter.
Member Function Documentation
|
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 from RParam.
void Insert | ( | RParam * | param | ) |
Add a new parameter to the list.
- Parameters
-
param Parameter to add.
T* Get | ( | const RString & | name | ) | const |
Get a parameter with a given name.
- Parameters
-
name Name of the parameter.
|
virtual |
Add a tag representing the values of the parameter.
- Parameters
-
xml XML structure. parent Parent tag.
Reimplemented from RParam.
|
virtual |
Reset the parameters of this structure.
Reimplemented from RParam.
Field Documentation
|
private |
Paramters.