List of parameter's values. More...
#include <rparam.h>
Inheritance diagram for RParamList:
Collaboration diagram for RParamList:
Public Member Functions | |
RParamList (const RXMLTag *tag) | |
RParamList (const RString &name, const RString &desc=RString::Null) | |
RCursor< RString > | GetList (void) const |
size_t | GetPos (const RString &value) const |
virtual bool | Set (RXMLTag *parent) |
void | Insert (const RString &value) |
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< RString, true, false > | Values |
Additional Inherited Members | |
Protected Attributes inherited from RParam | |
RString | Name |
RString | Description |
Detailed Description
List of parameter's values.
The RParamList class provides a representation for a parameter with multiple value.
Constructor & Destructor Documentation
RParamList | ( | const RXMLTag * | tag | ) |
Constructor of the parameter.
- Parameters
-
tag Tag.
RParamList | ( | const RString & | name, |
const RString & | desc = RString::Null |
||
) |
Constructor of the parameter.
- Parameters
-
name Name. desc Description of the parameter.
Member Function Documentation
size_t GetPos | ( | const RString & | value | ) | const |
Get the position of a particular value.
- Parameters
-
value Value to search for.
- Returns
- Position or SIZE_MAX if the value does not exist.
|
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 | ( | const RString & | value | ) |
Add a new value to the list.
- Parameters
-
value Value.
|
virtual |
Add a tag representing the values of the parameter.
- Parameters
-
xml XML structure. parent Parent tag.
Reimplemented from RParam.
|
virtual |
Reset the values of the parameter.
Reimplemented from RParam.
Field Documentation
|
private |
Values of the paramter.