Raytrix Light Field SDK
5.0
|
Interface for accessing (setting and getting) parameter values of a certain class.
Public Member Functions | |
void | ExportToFile (System::String^ sFilename) |
Exports all exportable parameter to file. More... | |
void | ExportToString (RX_OUT System::String ^ % sXmlString) |
Exports all exportable parameter to the given string by calling GetValue for each parameter. More... | |
void | GetDefinition (TEnum eID, RX_OUT System::String^ % sName, RX_OUT System::String^ % sGUID) |
Gets some parts of the parameter definition. More... | |
void | GetDefinition (TEnum eID, RX_OUT System::String^ % sName, RX_OUT System::String^ % sGUID, RX_OUT bool % bReadable, RX_OUT bool % bWritable, RX_OUT Rx::Net::EValueType % eType) |
Gets some parts of the parameter definition. More... | |
System::String ^ | GetGroupName (Params::EGroup eGroup) |
Gets the name of the given group ID. More... | |
void | GetValue (TEnum eID, RX_OUT array< double >^ % adValue) |
Gets the value of the given parameter. More... | |
void | GetValue (TEnum eID, RX_OUT array< System::String^>^ % asValue) |
Gets the value of the given parameter. More... | |
void | GetValue (TEnum eID, RX_OUT array< unsigned >^ % auValue) |
Gets the value of the given parameter. More... | |
void | GetValue (TEnum eID, RX_OUT double % dValue) |
Gets the value of the given parameter. More... | |
void | GetValue (TEnum eID, RX_OUT System::String^ % sValue) |
Gets the value of the given parameter. More... | |
void | GetValue (TEnum eID, RX_OUT unsigned % uValue) |
Gets the value of the given parameter. More... | |
void | GetValueRange (TEnum eID, RX_OUT double % dMin, RX_OUT double % dMax) |
Gets the valid range of the value that can be set to the given non-array parameter. More... | |
void | GetValueRange (TEnum eID, RX_OUT System::UInt64 % nArrayLenMin, RX_OUT System::UInt64 % nArrayLenMax, RX_OUT double % dMin, RX_OUT double % dMax) |
Gets the valid range of the value that can be set to the given array parameter. More... | |
void | GetValueRange (TEnum eID, RX_OUT System::UInt64 % nArrayLenMin, RX_OUT System::UInt64 % nArrayLenMax, RX_OUT unsigned % uMin, RX_OUT unsigned % uMax) |
Gets the valid range of the value that can be set to the given array parameter. More... | |
void | GetValueRange (TEnum eID, RX_OUT unsigned % uMin, RX_OUT unsigned % uMax) |
Gets the valid range of the value that can be set to the given non-array parameter. More... | |
void | ImportFromFile (System::String^ sFilename) |
Imports the parameter stored in the given file and applies each by calling SetValue. More... | |
void | ImportFromMetaData (Rx::Net::MetaData^ xMetaData) |
Import from meta data. If a class supports this functionality this class must implement this function. If a class does not implement this function nothing happens. More... | |
void | ImportFromString (System::String^ sXmlString) |
Imports the parameter stored in the given XML string and applies each by calling SetValue. More... | |
bool | IsValueValid (TEnum eID, array< double >^ adValue) |
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, array< System::String^>^ asValue) |
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, array< unsigned >^ auValue) |
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) |
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, System::String^ sValue) |
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, unsigned uValue) |
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 (bool bResetToInitial) |
Sets all parameters to their initial or their default value. More... | |
void | Reset (TEnum eID, bool bResetToInitial) |
Sets the parameter described by the given parameter ID to its initial or its default value. More... | |
void | SetValue (TEnum eID, array< double >^ adValue) |
Sets the value of the given parameter. More... | |
void | SetValue (TEnum eID, array< System::String^>^ asValue) |
Sets the value of the given parameter. More... | |
void | SetValue (TEnum eID, array< unsigned >^ auValue) |
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, System::String^ sValue) |
Sets the value of the given parameter. More... | |
void | SetValue (TEnum eID, unsigned uValue) |
Sets the value of the given parameter. More... | |
void Rx::LFR::Net::IParameters< TEnum >::ExportToFile | ( | System::String^ | sFilename | ) |
Exports all exportable parameter to file.
sFilename | [in] The complete file path. |
void Rx::LFR::Net::IParameters< TEnum >::ExportToString | ( | RX_OUT System::String ^ % | sXmlString | ) |
Exports all exportable parameter to the given string by calling GetValue for each parameter.
sXmlString | [out] The XML string. |
void Rx::LFR::Net::IParameters< TEnum >::GetDefinition | ( | TEnum | eID, |
RX_OUT System::String^ % | sName, | ||
RX_OUT System::String^ % | sGUID | ||
) |
Gets some parts of the parameter definition.
eID | [in] The parameter ID. |
sName | [out] The parameter name. |
sGUID | [out] The GUID of the parameter. |
void Rx::LFR::Net::IParameters< TEnum >::GetDefinition | ( | TEnum | eID, |
RX_OUT System::String^ % | sName, | ||
RX_OUT System::String^ % | sGUID, | ||
RX_OUT bool % | bReadable, | ||
RX_OUT bool % | bWritable, | ||
RX_OUT Rx::Net::EValueType % | eType | ||
) |
Gets some parts of the parameter definition.
eID | [in] The parameter ID. |
sName | [out] The parameter name. |
sGUID | [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. |
System::String ^ Rx::LFR::Net::IParameters< TEnum >::GetGroupName | ( | Params::EGroup | eGroup | ) |
Gets the name of the given group ID.
eGroup | [in] The group ID. |
void Rx::LFR::Net::IParameters< TEnum >::GetValue | ( | TEnum | eID, |
RX_OUT array< double >^ % | adValue | ||
) |
Gets the value of the given parameter.
eID | [in] The parameter ID. |
adValue | [out] The value. |
void Rx::LFR::Net::IParameters< TEnum >::GetValue | ( | TEnum | eID, |
RX_OUT array< System::String^>^ % | asValue | ||
) |
Gets the value of the given parameter.
eID | [in] The parameter ID. |
asValue | [out] The value. |
void Rx::LFR::Net::IParameters< TEnum >::GetValue | ( | TEnum | eID, |
RX_OUT array< unsigned >^ % | auValue | ||
) |
Gets the value of the given parameter.
eID | [in] The parameter ID. |
auValue | [out] The value. |
void Rx::LFR::Net::IParameters< TEnum >::GetValue | ( | TEnum | eID, |
RX_OUT double % | dValue | ||
) |
Gets the value of the given parameter.
eID | [in] The parameter ID. |
dValue | [out] The value. |
void Rx::LFR::Net::IParameters< TEnum >::GetValue | ( | TEnum | eID, |
RX_OUT System::String^ % | sValue | ||
) |
Gets the value of the given parameter.
eID | [in] The parameter ID. |
sValue | [out] The value. |
void Rx::LFR::Net::IParameters< TEnum >::GetValue | ( | TEnum | eID, |
RX_OUT unsigned % | uValue | ||
) |
Gets the value of the given parameter.
eID | [in] The parameter ID. |
uValue | [out] The value. |
void Rx::LFR::Net::IParameters< TEnum >::GetValueRange | ( | TEnum | eID, |
RX_OUT double % | dMin, | ||
RX_OUT double % | dMax | ||
) |
Gets the valid range of the value that can be set to the given non-array parameter.
eID | [in] The parameter ID. |
dMin | [out] The minimum value. |
dMax | [out] The maximum value. |
void Rx::LFR::Net::IParameters< TEnum >::GetValueRange | ( | TEnum | eID, |
RX_OUT System::UInt64 % | nArrayLenMin, | ||
RX_OUT System::UInt64 % | nArrayLenMax, | ||
RX_OUT double % | dMin, | ||
RX_OUT double % | dMax | ||
) |
Gets the valid range of the value that can be set to the given array parameter.
eID | [in] 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. |
void Rx::LFR::Net::IParameters< TEnum >::GetValueRange | ( | TEnum | eID, |
RX_OUT System::UInt64 % | nArrayLenMin, | ||
RX_OUT System::UInt64 % | nArrayLenMax, | ||
RX_OUT unsigned % | uMin, | ||
RX_OUT unsigned % | uMax | ||
) |
Gets the valid range of the value that can be set to the given array parameter.
eID | [in] 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::Net::IParameters< TEnum >::GetValueRange | ( | TEnum | eID, |
RX_OUT unsigned % | uMin, | ||
RX_OUT unsigned % | uMax | ||
) |
Gets the valid range of the value that can be set to the given non-array parameter.
eID | [in] The parameter ID. |
uMin | [out] The minimum value. |
uMax | [out] The maximum value. |
void Rx::LFR::Net::IParameters< TEnum >::ImportFromFile | ( | System::String^ | sFilename | ) |
Imports the parameter stored in the given file and applies each by calling SetValue.
sFilename | [in] The complete file path. |
void Rx::LFR::Net::IParameters< TEnum >::ImportFromMetaData | ( | Rx::Net::MetaData^ | xMetaData | ) |
Import from meta data. If a class supports this functionality this class must implement this function. If a class does not implement this function nothing happens.
xMetaData | [in] the meta data. |
void Rx::LFR::Net::IParameters< TEnum >::ImportFromString | ( | System::String^ | sXmlString | ) |
Imports the parameter stored in the given XML string and applies each by calling SetValue.
sXmlString | [in] The XML string. |
bool Rx::LFR::Net::IParameters< TEnum >::IsValueValid | ( | TEnum | eID, |
array< double >^ | adValue | ||
) |
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints.
eID | [in] The parameter ID. |
adValue | [in] The value. |
bool Rx::LFR::Net::IParameters< TEnum >::IsValueValid | ( | TEnum | eID, |
array< System::String^>^ | asValue | ||
) |
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints.
eID | [in] The parameter ID. |
asValue | [in] The value. |
bool Rx::LFR::Net::IParameters< TEnum >::IsValueValid | ( | TEnum | eID, |
array< unsigned >^ | auValue | ||
) |
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints.
eID | [in] The parameter ID. |
auValue | [in] The value. |
bool Rx::LFR::Net::IParameters< TEnum >::IsValueValid | ( | TEnum | eID, |
double | dValue | ||
) |
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints.
eID | [in] The parameter ID. |
dValue | [in] The value. |
bool Rx::LFR::Net::IParameters< TEnum >::IsValueValid | ( | TEnum | eID, |
System::String^ | sValue | ||
) |
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints.
eID | [in] The parameter ID. |
sValue | [in] The value. |
bool Rx::LFR::Net::IParameters< TEnum >::IsValueValid | ( | TEnum | eID, |
unsigned | uValue | ||
) |
Queries if the given value is a valid value for the given parameter ID. This tests the data type and possible constraints.
eID | [in] The parameter ID. |
uValue | [in] The value. |
void Rx::LFR::Net::IParameters< TEnum >::Reset | ( | bool | bResetToInitial | ) |
Sets all parameters to their initial or their default value.
bResetToInitial | [in] True to reset to initial, false to reset to default. False is default. |
void Rx::LFR::Net::IParameters< TEnum >::Reset | ( | TEnum | eID, |
bool | bResetToInitial | ||
) |
Sets the parameter described by the given parameter ID to its initial or its default value.
eID | [in] The parameter ID. |
bResetToInitial | [in] True to reset to initial, false to reset to default. False is default. |
void Rx::LFR::Net::IParameters< TEnum >::SetValue | ( | TEnum | eID, |
array< double >^ | adValue | ||
) |
Sets the value of the given parameter.
eID | [in] The parameter ID. |
adValue | [in] The value. |
void Rx::LFR::Net::IParameters< TEnum >::SetValue | ( | TEnum | eID, |
array< System::String^>^ | asValue | ||
) |
Sets the value of the given parameter.
eID | [in] The parameter ID. |
asValue | [in] The value. |
void Rx::LFR::Net::IParameters< TEnum >::SetValue | ( | TEnum | eID, |
array< unsigned >^ | auValue | ||
) |
Sets the value of the given parameter.
eID | [in] The parameter ID. |
auValue | [in] The value. |
void Rx::LFR::Net::IParameters< TEnum >::SetValue | ( | TEnum | eID, |
double | dValue | ||
) |
Sets the value of the given parameter.
eID | [in] The parameter ID. |
dValue | [in] The value. |
void Rx::LFR::Net::IParameters< TEnum >::SetValue | ( | TEnum | eID, |
System::String^ | sValue | ||
) |
Sets the value of the given parameter.
eID | [in] The parameter ID. |
sValue | [in] The value. |
void Rx::LFR::Net::IParameters< TEnum >::SetValue | ( | TEnum | eID, |
unsigned | uValue | ||
) |
Sets the value of the given parameter.
eID | [in] The parameter ID. |
uValue | [in] The value. |