Namespace: Rx::LFR – Class: CParameters – Header: Rx.LFR/Parameters.h
CParameters Class
#include "Rx.LFR/Parameters.h"
template<typename TEnum>
class CParameters : public CPimpl<CParameters_Impl<TEnum>, EParametersInterface>A base of all classes that need to get or set parameters.
Template Parameters
| TPimpl |
PIMPL. |
| TEnum |
The enum type that describes the parameter ID. |
Constructors
| CParameters(pxImpl, bFreeOnDelete) | Constructor. Only for internal purposes. |
Destructor
| ~CParameters() | Protected destructor. |
Methods
| IsValueValid(eID, uValue) | Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints. |
| IsValueValid(eID, dValue) | Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints. |
| IsValueValid(eID, sxValue) | Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints. |
| IsValueValid(eID, auValue) | Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints. |
| IsValueValid(eID, adValue) | Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints. |
| IsValueValid(eID, asValue) | Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints. |
| GetValueRange(eID, uMin, uMax) | Gets the valid range of the value that can be set to the given non-array parameter. |
| GetValueRange(eID, dMin, dMax) | Gets the valid range of the value that can be set to the given non-array parameter. |
| GetValueRange(eID, nArrayLenMin, nArrayLenMax, uMin, uMax) | Gets the valid range of the value that can be set to the given array parameter. |
| GetValueRange(eID, nArrayLenMin, nArrayLenMax, dMin, dMax) | Gets the valid range of the value that can be set to the given array parameter. |
| GetDefinition(eID, sxName, sxGUID) | Gets some parts of the parameter definition. |
| GetDefinition(paramId, name, guid, isReadable, isWritable, isExportable, valueType) | Gets some parts of the parameter definition. |
| Reset(eID, bResetToInitial) | Sets the parameter described by the given parameter ID to its initial or its default value. |
| Reset(bResetToInitial) | Sets all parameters to their initial or their default value. |
| SetValue(eID, uValue) | Sets the value of the given parameter. |
| SetValue(eID, dValue) | Sets the value of the given parameter. |
| SetValue(eID, sxValue) | Sets the value of the given parameter. |
| SetValue(eID, auValue) | Sets the value of the given parameter. |
| SetValue(eID, adValue) | Sets the value of the given parameter. |
| SetValue(eID, asValue) | Sets the value of the given parameter. |
| GetValue(eID, uValue) | Gets the value of the given parameter. |
| GetValue(eID, dValue) | Gets the value of the given parameter. |
| GetValue(eID, sxValue) | Gets the value of the given parameter. |
| GetValue(eID, auValue) | Gets the value of the given parameter. |
| GetValue(eID, adValue) | Gets the value of the given parameter. |
| GetValue(eID, asValue) | Gets the value of the given parameter. |
| GetValue(eID) | Gets the value of the given parameter. |
| ImportParameterFromFile(sxFilename) | Imports the parameter stored in the given file and applies each by calling SetValue. |
| ImportParameterFromString(sxXmlString) | Imports the parameter stored in the given XML string and applies each by calling SetValue. |
| ImportFromMetaData(xMetaData) | Imports the parameter stored in the given meta data and applies each by calling SetValue. |
| ExportParameterToFile(sxFilename) | Exports all exportable parameter to file. |
| ExportParameterToString(sxXmlString) | Exports all exportable parameter to the given string by calling GetValue for each parameter. |
| ExportParameterToString() | Exports all exportable parameter to the given string by calling GetValue for each parameter. |
| GetImpl() | Gets the non constant implementation. (Inherited from CPimpl) |
| GetImpl() | Gets the constant implementation. (Inherited from CPimpl) |
| GetInterface(eInterface) | Gets the interface defined by the given interface ID. (Inherited from CPimpl) |
| GetInterface(eInterface) | Gets the interface defined by the given interface ID. (Inherited from CPimpl) |
| GetInterface(eInterface) | Gets the interface defined by the given interface ID. (Inherited from CPimpl) |
| GetInterface(eInterface) | Gets the interface defined by the given interface ID. (Inherited from CPimpl) |
| HasInterface(eInterface) | Queries if this object has the given interface. (Inherited from CPimpl) |