Only-one value of parameter. More...
#include <rparam.h>
Public Member Functions | |
RParamValue (const RXMLTag *tag) | |
RParamValue (const RString &n, const RString &v, const RString &desc=RString::Null) | |
RParamValue (const RString &n, const char *v, const RString &desc=RString::Null) | |
RParamValue (const RString &n, long v, const RString &desc=RString::Null) | |
RParamValue (const RString &n, unsigned long v, const RString &desc=RString::Null) | |
RParamValue (const RString &n, int v, const RString &desc=RString::Null) | |
RParamValue (const RString &n, unsigned int v, const RString &desc=RString::Null) | |
RParamValue (const RString &n, double v, const RString &desc=RString::Null) | |
RParamValue (const RString &n, bool v, const RString &desc=RString::Null) | |
int | GetInt (void) const |
unsigned int | GetUInt (void) const |
long | GetLong (void) const |
unsigned long | GetULong (void) const |
double | GetDouble (void) const |
RString | Get (void) const |
bool | GetBool (void) const |
virtual bool | Set (RXMLTag *parent) |
void | SetInt (long long int v) |
void | SetUInt (unsigned long long int v) |
void | SetDouble (double v) |
void | Set (const RString &v) |
void | SetBool (bool v) |
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 | |
RString | Value |
Additional Inherited Members | |
Protected Attributes inherited from RParam | |
RString | Name |
RString | Description |
Detailed Description
Only-one value of parameter.
The RParamValue class provides a representation for a parameter with an unique value.
Constructor & Destructor Documentation
RParamValue | ( | const RXMLTag * | tag | ) |
Constructor of the parameter.
- Parameters
-
tag Tag;
RParamValue | ( | const RString & | n, |
const RString & | v, | ||
const RString & | desc = RString::Null |
||
) |
Constructor of the parameter with a 'value' attribute.
- Parameters
-
n Name of the parameter. v Value. desc Description of the parameter.
RParamValue | ( | const RString & | n, |
const char * | v, | ||
const RString & | desc = RString::Null |
||
) |
Constructor of the parameter with a 'value' attribute.
- Parameters
-
n Name of the parameter. v Value. desc Description of the parameter.
RParamValue | ( | const RString & | n, |
long | v, | ||
const RString & | desc = RString::Null |
||
) |
Constructor of the parameter with a 'value' attribute.
- Parameters
-
n Name of the parameter. v Value. desc Description of the parameter.
RParamValue | ( | const RString & | n, |
unsigned long | v, | ||
const RString & | desc = RString::Null |
||
) |
Constructor of the parameter with a 'value' attribute.
- Parameters
-
n Name of the parameter. v Value. desc Description of the parameter.
RParamValue | ( | const RString & | n, |
int | v, | ||
const RString & | desc = RString::Null |
||
) |
Constructor of the parameter with a 'value' attribute.
- Parameters
-
n Name of the parameter. v Value. desc Description of the parameter.
RParamValue | ( | const RString & | n, |
unsigned int | v, | ||
const RString & | desc = RString::Null |
||
) |
Constructor of the parameter with a 'value' attribute.
- Parameters
-
n Name of the parameter. v Value. desc Description of the parameter.
RParamValue | ( | const RString & | n, |
double | v, | ||
const RString & | desc = RString::Null |
||
) |
Constructor of the parameter with a 'value' attribute.
- Parameters
-
n Name of the parameter. v Value. desc Description of the parameter.
RParamValue | ( | const RString & | n, |
bool | v, | ||
const RString & | desc = RString::Null |
||
) |
Constructor of the parameter with a 'value' attribute.
- Parameters
-
n Name of the parameter. v Value. desc Description of the parameter.
Member Function Documentation
int GetInt | ( | void | ) | const |
Get the content of the parameter.
- Returns
- int.
unsigned int GetUInt | ( | void | ) | const |
Get the content of the parameter.
long GetLong | ( | void | ) | const |
Get the content of the parameter.
- Returns
- int.
unsigned long GetULong | ( | void | ) | const |
Get the content of the parameter.
double GetDouble | ( | void | ) | const |
Get the content of the parameter.
- Returns
- double.
RString Get | ( | void | ) | const |
Get the content of the parameter.
- Returns
- string.
bool GetBool | ( | void | ) | const |
Get the content of the parameter.
- Returns
- bool.
|
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 SetInt | ( | long long int | v | ) |
Set the content of the parameter.
- Parameters
-
v Value of the parameter.
void SetUInt | ( | unsigned long long int | v | ) |
Set the content of the parameter.
- Parameters
-
v Value of the parameter.
void SetDouble | ( | double | v | ) |
Set the content of the parameter.
- Parameters
-
v Value of the parameter.
void Set | ( | const RString & | v | ) |
Set the content of the parameter.
- Parameters
-
v Value of the parameter.
void SetBool | ( | bool | v | ) |
Set the content of the parameter.
- Parameters
-
v Value 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 value of the parameter.
Reimplemented from RParam.
Field Documentation
|
private |
Value of the parameter.