Raytrix Light Field SDK  5.0
Rx::LFR::Net::IParameters< TEnum > Interface Template Reference

Detailed Description

template<class TEnum>
interface Rx::LFR::Net::IParameters< TEnum >

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...
 

Member Function Documentation

◆ ExportToFile()

template<class TEnum >
void Rx::LFR::Net::IParameters< TEnum >::ExportToFile ( System::String^  sFilename)

Exports all exportable parameter to file.

Parameters
sFilename[in] The complete file path.

◆ ExportToString()

template<class TEnum >
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.

Parameters
sXmlString[out] The XML string.

◆ GetDefinition() [1/2]

template<class TEnum >
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.

Parameters
eID[in] The parameter ID.
sName[out] The parameter name.
sGUID[out] The GUID of the parameter.

◆ GetDefinition() [2/2]

template<class TEnum >
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.

Parameters
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.

◆ GetGroupName()

template<class TEnum >
System::String ^ Rx::LFR::Net::IParameters< TEnum >::GetGroupName ( Params::EGroup  eGroup)

Gets the name of the given group ID.

Parameters
eGroup[in] The group ID.
Returns
Empty string if the name is missing, else the group name.

◆ GetValue() [1/6]

template<class TEnum >
void Rx::LFR::Net::IParameters< TEnum >::GetValue ( TEnum  eID,
RX_OUT array< double >^ %  adValue 
)

Gets the value of the given parameter.

Parameters
eID[in] The parameter ID.
adValue[out] The value.

◆ GetValue() [2/6]

template<class TEnum >
void Rx::LFR::Net::IParameters< TEnum >::GetValue ( TEnum  eID,
RX_OUT array< System::String^>^ %  asValue 
)

Gets the value of the given parameter.

Parameters
eID[in] The parameter ID.
asValue[out] The value.

◆ GetValue() [3/6]

template<class TEnum >
void Rx::LFR::Net::IParameters< TEnum >::GetValue ( TEnum  eID,
RX_OUT array< unsigned >^ %  auValue 
)

Gets the value of the given parameter.

Parameters
eID[in] The parameter ID.
auValue[out] The value.

◆ GetValue() [4/6]

template<class TEnum >
void Rx::LFR::Net::IParameters< TEnum >::GetValue ( TEnum  eID,
RX_OUT double %  dValue 
)

Gets the value of the given parameter.

Parameters
eID[in] The parameter ID.
dValue[out] The value.

◆ GetValue() [5/6]

template<class TEnum >
void Rx::LFR::Net::IParameters< TEnum >::GetValue ( TEnum  eID,
RX_OUT System::String^ %  sValue 
)

Gets the value of the given parameter.

Parameters
eID[in] The parameter ID.
sValue[out] The value.

◆ GetValue() [6/6]

template<class TEnum >
void Rx::LFR::Net::IParameters< TEnum >::GetValue ( TEnum  eID,
RX_OUT unsigned %  uValue 
)

Gets the value of the given parameter.

Parameters
eID[in] The parameter ID.
uValue[out] The value.

◆ GetValueRange() [1/4]

template<class TEnum >
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.

Parameters
eID[in] The parameter ID.
dMin[out] The minimum value.
dMax[out] The maximum value.

◆ GetValueRange() [2/4]

template<class TEnum >
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.

Parameters
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.

◆ GetValueRange() [3/4]

template<class TEnum >
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.

Parameters
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.

◆ GetValueRange() [4/4]

template<class TEnum >
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.

Parameters
eID[in] The parameter ID.
uMin[out] The minimum value.
uMax[out] The maximum value.

◆ ImportFromFile()

template<class TEnum >
void Rx::LFR::Net::IParameters< TEnum >::ImportFromFile ( System::String^  sFilename)

Imports the parameter stored in the given file and applies each by calling SetValue.

Parameters
sFilename[in] The complete file path.

◆ ImportFromMetaData()

template<class TEnum >
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.

Parameters
xMetaData[in] the meta data.

◆ ImportFromString()

template<class TEnum >
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.

Parameters
sXmlString[in] The XML string.

◆ IsValueValid() [1/6]

template<class TEnum >
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.

Parameters
eID[in] The parameter ID.
adValue[in] The value.
Returns
True if the value is valid, false if not.

◆ IsValueValid() [2/6]

template<class TEnum >
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.

Parameters
eID[in] The parameter ID.
asValue[in] The value.
Returns
True if the value is valid, false if not.

◆ IsValueValid() [3/6]

template<class TEnum >
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.

Parameters
eID[in] The parameter ID.
auValue[in] The value.
Returns
True if the value is valid, false if not.

◆ IsValueValid() [4/6]

template<class TEnum >
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.

Parameters
eID[in] The parameter ID.
dValue[in] The value.
Returns
True if the value is valid, false if not.

◆ IsValueValid() [5/6]

template<class TEnum >
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.

Parameters
eID[in] The parameter ID.
sValue[in] The value.
Returns
True if the value is valid, false if not.

◆ IsValueValid() [6/6]

template<class TEnum >
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.

Parameters
eID[in] The parameter ID.
uValue[in] The value.
Returns
True if the value is valid, false if not.

◆ Reset() [1/2]

template<class TEnum >
void Rx::LFR::Net::IParameters< TEnum >::Reset ( bool  bResetToInitial)

Sets all parameters to their initial or their default value.

Parameters
bResetToInitial[in] True to reset to initial, false to reset to default. False is default.

◆ Reset() [2/2]

template<class TEnum >
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.

Parameters
eID[in] The parameter ID.
bResetToInitial[in] True to reset to initial, false to reset to default. False is default.

◆ SetValue() [1/6]

template<class TEnum >
void Rx::LFR::Net::IParameters< TEnum >::SetValue ( TEnum  eID,
array< double >^  adValue 
)

Sets the value of the given parameter.

Parameters
eID[in] The parameter ID.
adValue[in] The value.

◆ SetValue() [2/6]

template<class TEnum >
void Rx::LFR::Net::IParameters< TEnum >::SetValue ( TEnum  eID,
array< System::String^>^  asValue 
)

Sets the value of the given parameter.

Parameters
eID[in] The parameter ID.
asValue[in] The value.

◆ SetValue() [3/6]

template<class TEnum >
void Rx::LFR::Net::IParameters< TEnum >::SetValue ( TEnum  eID,
array< unsigned >^  auValue 
)

Sets the value of the given parameter.

Parameters
eID[in] The parameter ID.
auValue[in] The value.

◆ SetValue() [4/6]

template<class TEnum >
void Rx::LFR::Net::IParameters< TEnum >::SetValue ( TEnum  eID,
double  dValue 
)

Sets the value of the given parameter.

Parameters
eID[in] The parameter ID.
dValue[in] The value.

◆ SetValue() [5/6]

template<class TEnum >
void Rx::LFR::Net::IParameters< TEnum >::SetValue ( TEnum  eID,
System::String^  sValue 
)

Sets the value of the given parameter.

Parameters
eID[in] The parameter ID.
sValue[in] The value.

◆ SetValue() [6/6]

template<class TEnum >
void Rx::LFR::Net::IParameters< TEnum >::SetValue ( TEnum  eID,
unsigned  uValue 
)

Sets the value of the given parameter.

Parameters
eID[in] The parameter ID.
uValue[in] The value.