A base of all classes that need to get or set parameters.
TPimpl | PIMPL. |
TEnum | The enum type that describes the parameter ID. |
Inherits Rx::LFR::CPimpl< CParameters_Impl< TEnum >, Interfaces::EParameters::ID >.
Public Member Functions | |
CParameters (CParameters_Impl< TEnum > *pxImpl, bool bFreeOnDelete=true) | |
Constructor. Only for internal purposes. More... | |
~CParameters () | |
Protected destructor. More... | |
void | ExportParameterToFile (const CRxString &sxFilename) const |
Exports all exportable parameter to file. More... | |
void | ExportParameterToString (CRxString &sxXmlString) const |
Exports all exportable parameter to the given string by calling GetValue for each parameter. More... | |
void | GetDefinition (TEnum eID, CRxString &sxName, CRxString &sxGUID) const |
Gets some parts of the parameter definition. More... | |
void | GetDefinition (TEnum eID, CRxString &sxName, CRxString &sxGUID, bool &bReadable, bool &bWritable, EValueType::ID &eType) const |
Gets some parts of the parameter definition. More... | |
CParameters_Impl< TEnum > & | GetImpl () |
Gets the non constant implementation. More... | |
const CParameters_Impl< TEnum > & | GetImpl () const |
Gets the constant implementation. More... | |
void * | GetInterface (Interfaces::EParameters::ID eInterface) |
Gets the interface defined by the given interface ID. More... | |
const void * | GetInterface (Interfaces::EParameters::ID eInterface) const |
Gets the interface defined by the given interface ID. More... | |
TInterface * | GetInterface (Interfaces::EParameters::ID eInterface) |
Gets the interface defined by the given interface ID. More... | |
const TInterface * | GetInterface (Interfaces::EParameters::ID eInterface) const |
Gets the interface defined by the given interface ID. More... | |
void | GetValue (TEnum eID, unsigned &uValue) const |
Gets the value of the given parameter. More... | |
void | GetValue (TEnum eID, double &dValue) const |
Gets the value of the given parameter. More... | |
void | GetValue (TEnum eID, CRxString &sxValue) const |
Gets the value of the given parameter. More... | |
void | GetValue (TEnum eID, CRxArrayUInt &auValue) const |
Gets the value of the given parameter. More... | |
void | GetValue (TEnum eID, CRxArrayDouble &adValue) const |
Gets the value of the given parameter. More... | |
void | GetValue (TEnum eID, CRxArrayString &asValue) const |
Gets the value of the given parameter. More... | |
void | GetValueRange (TEnum eID, unsigned &uMin, unsigned &uMax) const |
Gets the valid range of the value that can be set to the given non-array parameter. More... | |
void | GetValueRange (TEnum eID, double &dMin, double &dMax) const |
Gets the valid range of the value that can be set to the given non-array parameter. More... | |
void | GetValueRange (TEnum eID, size_t &nArrayLenMin, size_t &nArrayLenMax, unsigned &uMin, unsigned &uMax) const |
Gets the valid range of the value that can be set to the given array parameter. More... | |
void | GetValueRange (TEnum eID, size_t &nArrayLenMin, size_t &nArrayLenMax, double &dMin, double &dMax) const |
Gets the valid range of the value that can be set to the given array parameter. More... | |
bool | HasInterface (Interfaces::EParameters::ID eInterface) |
Queries if this object has the given interface. More... | |
void | ImportFromMetaData (const CRxMetaData &xMetaData) |
Import from meta data. More... | |
void | ImportParameterFromFile (const CRxString &sxFilename) |
Imports the parameter stored in the given file and applies each by calling SetValue. More... | |
void | ImportParameterFromString (const CRxString &sxXmlString) |
Imports the parameter stored in the given XML string and applies each by calling SetValue. More... | |
bool | IsValueValid (TEnum eID, unsigned uValue) const |
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints. More... | |
bool | IsValueValid (TEnum eID, double dValue) const |
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints. More... | |
bool | IsValueValid (TEnum eID, const CRxString &sxValue) const |
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints. More... | |
bool | IsValueValid (TEnum eID, const CRxArrayUInt &auValue) const |
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints. More... | |
bool | IsValueValid (TEnum eID, const CRxArrayDouble &adValue) const |
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints. More... | |
bool | IsValueValid (TEnum eID, const CRxArrayString &asValue) const |
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints. More... | |
void | Reset (TEnum eID, bool bResetToInitial=false) |
Sets the parameter described by the given parameter ID to its initial or its default value. More... | |
void | Reset (bool bResetToInitial=false) |
Sets all parameters to their initial or their default value. More... | |
void | SetValue (TEnum eID, unsigned uValue) |
Sets the value of the given parameter. More... | |
void | SetValue (TEnum eID, double dValue) |
Sets the value of the given parameter. More... | |
void | SetValue (TEnum eID, const CRxString &sxValue) |
Sets the value of the given parameter. More... | |
void | SetValue (TEnum eID, const CRxArrayUInt &auValue) |
Sets the value of the given parameter. More... | |
void | SetValue (TEnum eID, const CRxArrayDouble &adValue) |
Sets the value of the given parameter. More... | |
void | SetValue (TEnum eID, const CRxArrayString &asValue) |
Sets the value of the given parameter. More... | |
Static Public Member Functions | |
static const char * | GetParamterGroupName (Params::EGroup::ID eGroup) |
Gets the name of the given group ID. More... | |
Rx::LFR::CParameters< TEnum >::CParameters | ( | CParameters_Impl< TEnum > * | pxImpl, |
bool | bFreeOnDelete = true |
||
) |
Constructor. Only for internal purposes.
pxImpl | [out] The implementation class. |
bFreeOnDelete | (Optional) True to free the memory of the given implementation class on deleting this object. |
|
inline |
Protected destructor.
void Rx::LFR::CParameters< TEnum >::ExportParameterToFile | ( | const CRxString & | sxFilename | ) | const |
Exports all exportable parameter to file.
sxFilename | The file name. |
void Rx::LFR::CParameters< TEnum >::ExportParameterToString | ( | CRxString & | sxXmlString | ) | const |
Exports all exportable parameter to the given string by calling GetValue for each parameter.
sxXmlString | [out] The XML string. |
void Rx::LFR::CParameters< TEnum >::GetDefinition | ( | TEnum | eID, |
CRxString & | sxName, | ||
CRxString & | sxGUID | ||
) | const |
Gets some parts of the parameter definition.
eID | The parameter ID. |
sxName | [out] The parameter name. |
sxGUID | [out] The GUID of the parameter. |
void Rx::LFR::CParameters< TEnum >::GetDefinition | ( | TEnum | eID, |
CRxString & | sxName, | ||
CRxString & | sxGUID, | ||
bool & | bReadable, | ||
bool & | bWritable, | ||
EValueType::ID & | eType | ||
) | const |
Gets some parts of the parameter definition.
eID | The parameter ID. |
sxName | [out] The parameter name. |
sxGUID | [out] The GUID of the parameter. |
bReadable | [out] True if the parameter is readable. |
bWritable | [out] True if the parameter is writable. |
eType | [out] The data type of the parameter. |
|
inlineinherited |
Gets the non constant implementation.
|
inlineinherited |
Gets the constant implementation.
|
inherited |
Gets the interface defined by the given interface ID.
eInterface | The interface ID. |
|
inherited |
Gets the interface defined by the given interface ID.
eInterface | The interface ID. |
|
inlineinherited |
Gets the interface defined by the given interface ID.
TInterface | The interface type. |
eInterface | The interface. |
|
inlineinherited |
Gets the interface defined by the given interface ID.
TInterface | The interface type. |
eInterface | The interface ID. |
|
static |
Gets the name of the given group ID.
eGroup | The group ID. |
void Rx::LFR::CParameters< TEnum >::GetValue | ( | TEnum | eID, |
unsigned & | uValue | ||
) | const |
Gets the value of the given parameter.
eID | The parameter ID. |
uValue | [out] The value. |
void Rx::LFR::CParameters< TEnum >::GetValue | ( | TEnum | eID, |
double & | dValue | ||
) | const |
Gets the value of the given parameter.
eID | The parameter ID. |
dValue | [out] The value. |
void Rx::LFR::CParameters< TEnum >::GetValue | ( | TEnum | eID, |
CRxString & | sxValue | ||
) | const |
Gets the value of the given parameter.
eID | The parameter ID. |
sxValue | [out] The value. |
void Rx::LFR::CParameters< TEnum >::GetValue | ( | TEnum | eID, |
CRxArrayUInt & | auValue | ||
) | const |
Gets the value of the given parameter.
eID | The parameter ID. |
auValue | [out] The value. |
void Rx::LFR::CParameters< TEnum >::GetValue | ( | TEnum | eID, |
CRxArrayDouble & | adValue | ||
) | const |
Gets the value of the given parameter.
eID | The parameter ID. |
adValue | [out] The value. |
void Rx::LFR::CParameters< TEnum >::GetValue | ( | TEnum | eID, |
CRxArrayString & | asValue | ||
) | const |
Gets the value of the given parameter.
eID | The parameter ID. |
asValue | [out] The value. |
void Rx::LFR::CParameters< TEnum >::GetValueRange | ( | TEnum | eID, |
unsigned & | uMin, | ||
unsigned & | uMax | ||
) | const |
Gets the valid range of the value that can be set to the given non-array parameter.
eID | The parameter ID. |
uMin | [out] The minimum value. |
uMax | [out] The maximum value. |
void Rx::LFR::CParameters< TEnum >::GetValueRange | ( | TEnum | eID, |
double & | dMin, | ||
double & | dMax | ||
) | const |
Gets the valid range of the value that can be set to the given non-array parameter.
eID | The parameter ID. |
dMin | [out] The minimum value. |
dMax | [out] The maximum value. |
void Rx::LFR::CParameters< TEnum >::GetValueRange | ( | TEnum | eID, |
size_t & | nArrayLenMin, | ||
size_t & | nArrayLenMax, | ||
unsigned & | uMin, | ||
unsigned & | uMax | ||
) | const |
Gets the valid range of the value that can be set to the given array parameter.
eID | The parameter ID. |
nArrayLenMin | [out] The minimum array length. |
nArrayLenMax | [out] The maximum array length. |
uMin | [out] The minimum value of each array element. |
uMax | [out] The maximum value of each array element. |
void Rx::LFR::CParameters< TEnum >::GetValueRange | ( | TEnum | eID, |
size_t & | nArrayLenMin, | ||
size_t & | nArrayLenMax, | ||
double & | dMin, | ||
double & | dMax | ||
) | const |
Gets the valid range of the value that can be set to the given array parameter.
eID | The parameter ID. |
nArrayLenMin | [out] The minimum array length. |
nArrayLenMax | [out] The maximum array length. |
dMin | [out] The minimum value of each array element. |
dMax | [out] The maximum value of each array element. |
|
inlineinherited |
Queries if this object has the given interface.
eInterface | The interface to query. |
void Rx::LFR::CParameters< TEnum >::ImportFromMetaData | ( | const CRxMetaData & | xMetaData | ) |
Import from meta data.
xMetaData | the meta data. |
void Rx::LFR::CParameters< TEnum >::ImportParameterFromFile | ( | const CRxString & | sxFilename | ) |
Imports the parameter stored in the given file and applies each by calling SetValue.
sxFilename | The file name. |
void Rx::LFR::CParameters< TEnum >::ImportParameterFromString | ( | const CRxString & | sxXmlString | ) |
Imports the parameter stored in the given XML string and applies each by calling SetValue.
sxXmlString | The XML string. |
bool Rx::LFR::CParameters< TEnum >::IsValueValid | ( | TEnum | eID, |
unsigned | uValue | ||
) | const |
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints.
eID | The parameter ID. |
uValue | The value. |
bool Rx::LFR::CParameters< TEnum >::IsValueValid | ( | TEnum | eID, |
double | dValue | ||
) | const |
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints.
eID | The parameter ID. |
dValue | The value. |
bool Rx::LFR::CParameters< TEnum >::IsValueValid | ( | TEnum | eID, |
const CRxString & | sxValue | ||
) | const |
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints.
eID | The parameter ID. |
sxValue | The value. |
bool Rx::LFR::CParameters< TEnum >::IsValueValid | ( | TEnum | eID, |
const CRxArrayUInt & | auValue | ||
) | const |
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints.
eID | The parameter ID. |
auValue | The value. |
bool Rx::LFR::CParameters< TEnum >::IsValueValid | ( | TEnum | eID, |
const CRxArrayDouble & | adValue | ||
) | const |
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints.
eID | The parameter ID. |
adValue | The value. |
bool Rx::LFR::CParameters< TEnum >::IsValueValid | ( | TEnum | eID, |
const CRxArrayString & | asValue | ||
) | const |
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints.
eID | The parameter ID. |
asValue | The value. |
void Rx::LFR::CParameters< TEnum >::Reset | ( | TEnum | eID, |
bool | bResetToInitial = false |
||
) |
Sets the parameter described by the given parameter ID to its initial or its default value.
eID | The parameter ID. |
bResetToInitial | (Optional) True to reset to initial, false to reset to default. |
void Rx::LFR::CParameters< TEnum >::Reset | ( | bool | bResetToInitial = false | ) |
Sets all parameters to their initial or their default value.
bResetToInitial | (Optional) True to reset to initial, false to reset to default. |
void Rx::LFR::CParameters< TEnum >::SetValue | ( | TEnum | eID, |
unsigned | uValue | ||
) |
Sets the value of the given parameter.
eID | The parameter ID. |
uValue | The value. |
void Rx::LFR::CParameters< TEnum >::SetValue | ( | TEnum | eID, |
double | dValue | ||
) |
Sets the value of the given parameter.
eID | The parameter ID. |
dValue | The value. |
void Rx::LFR::CParameters< TEnum >::SetValue | ( | TEnum | eID, |
const CRxString & | sxValue | ||
) |
Sets the value of the given parameter.
eID | The parameter ID. |
sxValue | The value. |
void Rx::LFR::CParameters< TEnum >::SetValue | ( | TEnum | eID, |
const CRxArrayUInt & | auValue | ||
) |
Sets the value of the given parameter.
eID | The parameter ID. |
auValue | The value. |
void Rx::LFR::CParameters< TEnum >::SetValue | ( | TEnum | eID, |
const CRxArrayDouble & | adValue | ||
) |
Sets the value of the given parameter.
eID | The parameter ID. |
adValue | The value. |
void Rx::LFR::CParameters< TEnum >::SetValue | ( | TEnum | eID, |
const CRxArrayString & | asValue | ||
) |
Sets the value of the given parameter.
eID | The parameter ID. |
asValue | The value. |