Functions to get/set API parameters. More...
Functions | |
static System::Void | Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, System::UInt32% uValue) |
Get a parameter of type unsigned integer . More... | |
static System::Void | Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, System::Double% dValue) |
Get a parameter of type double . More... | |
static System::Void | Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, System::String^ %sValue) |
Get a parameter of type System::String . More... | |
static System::Void | Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, array< System::UInt32 >^%aValue) |
Get Parameter of type array<System::UInt32> . More... | |
static System::Void | Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, array< System::Double >^%aValue) |
Get Parameter of type array<System::Double> . More... | |
static System::Void | Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, array< System::String^ >^%aValue) |
Get Parameter of type array<System::String^> . More... | |
static System::Void | Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, System::UInt32 uIndex, System::UInt32% uValue) |
Get Parameter of type unsigned int.This function is related to the overloaded function. More... | |
static System::Void | Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, System::UInt32 uIndex, System::Double% dValue) |
Get Parameter of type unsigned int. This function is related to the overloaded function. More... | |
static System::Void | Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, System::UInt32 uIndex, System::String^ %sValue) |
Get Parameter of type unsigned int. This function is related to the overloaded function. More... | |
static System::Void | Rx::Net::ApiLF::RxGetParName (Rx::Net::ApiLF::EPar ePar, System::String^ %aValue) |
Get the string representation of a parameter. More... | |
static System::Void | Rx::Net::ApiLF::RxGetParProperties (Rx::Net::ApiLF::EPar ePar, System::String^ %sName, System::Boolean% bReadAccess, System::Boolean% bWriteAccess, Rx::Net::ApiLF::EParameterDataType% eType) |
Get the Properties of a parameter. More... | |
static System::Void | Rx::Net::ApiLF::RxGetParRange (Rx::Net::ApiLF::EPar ePar, System::UInt32% uMin, System::UInt32% uMax) |
Get the range of a parameter. More... | |
static System::Void | Rx::Net::ApiLF::RxGetParRange (Rx::Net::ApiLF::EPar ePar, System::Double% dMin, System::Double% dMax) |
Get the range of a parameter. More... | |
static System::Void | Rx::Net::ApiLF::RxGetParRange (Rx::Net::ApiLF::EPar ePar, System::Int32% iArrayLenMin, System::Int32% iArrayLenMax, System::UInt32% uMin, System::UInt32% uMax) |
Get the range of a parameter. Some array-based parameter have a dynamic array size. The parameter iArrayLenMin and iArrayLenMax returns the allowed length of the array on a zero based index. More... | |
static System::Void | Rx::Net::ApiLF::RxGetParRange (Rx::Net::ApiLF::EPar ePar, System::Int32% iArrayLenMin, System::Int32% iArrayLenMax, System::Double% uMin, System::Double% uMax) |
Get the range of a parameter. Some array-based parameter have a dynamic array size. The parameter iArrayLenMin and iArrayLenMax returns the allowed length of the array on a zero based index. More... | |
static System::Void | Rx::Net::ApiLF::RxLoadParameter (System::String^ sFilename) |
Loads all writable API parameter from file. Its mandatory to bind a light field image before. More... | |
static System::Void | Rx::Net::ApiLF::RxSaveParameter (System::String^ sFilename) |
Saves all writable API parameter to file. Its mandatory to bind a light field image before. More... | |
static System::Void | Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, System::UInt32 uValue) |
Set a parameter of type unsigned integer . More... | |
static System::Void | Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, System::Double dValue) |
Set a parameter of type double . More... | |
static System::Void | Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, System::String^ sValue) |
Set a parameter of type System::String. More... | |
static System::Void | Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, array< System::UInt32 >^aValue) |
Set a parameter of typearray<System::UInt32> . More... | |
static System::Void | Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, array< System::Double >^aValue) |
Set a parameter of type array<System::Double> . More... | |
static System::Void | Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, array< System::String^ >^aValue) |
Set a parameter of type array<System::String^> . More... | |
static System::Void | Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, System::UInt32 uIndex, System::UInt32 uValue) |
Receive set par. Set a Parameter of type unsiged . This function is related to void Rx::Net::ApiLF::RxSetPar(Rx::Net::ApiLF::EPar::ID ePar,const Rx::CRxArrayUInt aValue) and sets the Value of the array on the given index. More... | |
static System::Void | Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, System::UInt32 uIndex, System::Double dValue) |
Set a Parameter of type unsiged . This function is related to void RxSetPar(EPar::ID ePar, const array< System::Double^> aValue) and sets the Value of the array on the given index. More... | |
static System::Void | Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, System::UInt32 uIndex, System::String^ sValue) |
Set a Parameter of type unsiged . This function is related to void RxSetPar(EPar::ID ePar, const array< System::String^> aValue) and sets the Value of the array on the given index. More... | |
Functions to get/set API parameters.
With these functions parameters of the API can be read and set. The parameter IDs are defined in Rx::Net::ApiLF::EPar
. Note that the parameters starting with Rx::Net::ApiLF::EPar::Cam_
and Rx::Net::ApiLF::EPar::CamCal_
have to be read and set with Rx::Net::ApiLF::RxCamGetPar and Rx::Net::ApiLF::RxCamSetPar, with the exeception of Rx::Net::ApiLF::EPar::Cam_Count
. The parameters are grouped in the following categories:
|
static |
Get a parameter of type unsigned
integer
.
unsigned
parameter an Rx::Net::RxException is thrown.
|
static |
Get a parameter of type double
.
double
parameter an Rx::Net::RxException is thrown.
|
static |
Get a parameter of type System::String
.
string
parameter an Rx::Net::RxException is thrown.ePar | The parameter ID. Allowed enum values are:
| |
[out] | sValue | On return contains the parameter value. |
|
static |
Get Parameter of type array<System::UInt32>
.
array<System::UInt32>
parameter, then an Rx::Net::RxException is thrown.ePar | The parameter ID. Allowed enum values are: | |
[out] | aValue | The array containing the parameter Value. |
|
static |
Get Parameter of type array<System::Double>
.
array<System::Double>
parameter, then an Rx::Net::RxException is thrown.ePar | The parameter ID. Allowed enum values are:
| |
[out] | aValue | The array containing the parameter Value. |
|
static |
Get Parameter of type array<System::String^>
.
array<System::String^>
parameter, then an Rx::Net::RxException is thrown.ePar | The parameter ID. | |
[out] | aValue | The array containing the parameter Value. |
|
static |
Get Parameter of type unsigned int.This function is related to the overloaded function.
and will return the Value of the parameter array on given index.
array<System::UInt32>
parameter, then an Rx::Net::RxException is thrown.ePar | The parameter ID. Allowed enum values are: | |
uIndex | The array index. | |
[out] | uValue | The variable containing the parameter Value. |
|
static |
Get Parameter of type unsigned int. This function is related to the overloaded function.
and will return the Value of the parameter array on given index.
array<System::Double>
parameter, then an Rx::Net::RxException is thrown.ePar | The parameter ID. Allowed enum values are:
| |
uIndex | The array index. | |
[out] | dValue | The variable containing the parameter Value. |
|
static |
Get Parameter of type unsigned int. This function is related to the overloaded function.
and will return the Value of the parameter array on given index.
array<System::String>
parameter, then an Rx::Net::RxException is thrown.ePar | The parameter ID. | |
uIndex | The array index. | |
[out] | sValue | The variable containing the parameter Value. |
|
static |
Get the string representation of a parameter.
ePar | The parameter ID. Allowed enums are in Rx::Net::ApiLF::EPar. | |
[out] | aValue | On return contains the parameter string representation. |
|
static |
Get the Properties of a parameter.
ePar | The parameter ID. Allowed enums are in Rx::Net::ApiLF::EPar. | |
[out] | sName | On return contains the parameter string representation. |
[out] | bReadAccess | On return contains the parameter ReadAccess flag. |
[out] | bWriteAccess | On return contains the parameter WriteAccess flag. |
[out] | eType | On return contains the parameter DataType. |
|
static |
Get the range of a parameter.
unsigned
parameter, then an Rx::Net::RxException is thrown.
|
static |
Get the range of a parameter.
double
parameter, then an Rx::Net::RxException is thrown.ePar | The parameter ID. Allowed enum values are:
| |
[out] | dMin | The minimal value. |
[out] | dMax | The maximal value. |
|
static |
Get the range of a parameter. Some array-based parameter have a dynamic array size. The parameter iArrayLenMin and iArrayLenMax returns the allowed length of the array on a zero based index.
ePar | The parameter ID. Allowed enum values are: | |
[out] | iArrayLenMin | Zero-based index of the array length minimum. |
[out] | iArrayLenMax | Zero-based index of the array length maximum. |
[out] | uMin | The minimum. |
[out] | uMax | The maximum. |
|
static |
Get the range of a parameter. Some array-based parameter have a dynamic array size. The parameter iArrayLenMin and iArrayLenMax returns the allowed length of the array on a zero based index.
ePar | The parameter ID. Allowed enum values are:
| |
[out] | iArrayLenMin | Zero-based index of the array length minimum. |
[out] | iArrayLenMax | Zero-based index of the array length maximum. |
[out] | uMin | The minimum. |
[out] | uMax | The maximum. |
|
static |
Loads all writable API parameter from file. Its mandatory to bind a light field image before.
[in] | sFilename | The file name. |
|
static |
Saves all writable API parameter to file. Its mandatory to bind a light field image before.
This save routine will not store API parameter related to a specific device(e.g.camera or cuda device).
The following parameter groups are excluded from saving:
in addition to the excluded groups, the following parameter are also excluded:
[in] | sFilename | The file name. |
|
static |
Set a parameter of type unsigned
integer
.
unsigned
integer
parameter, then an Rx::Net::RxException is thrown.
|
static |
Set a parameter of type double
.
double
parameter, then an Rx::Net::RxException is thrown.
|
static |
Set a parameter of type System::String.
double
parameter, then an Rx::Net::RxException is thrown.ePar | The parameter ID. Allowed enum values are:
| |
[in] | sValue | The parameter value. |
|
static |
Set a parameter of typearray<System::UInt32>
.
ePar
does not relate to an array<System::UInt32>
parameter, then a Rx::Net::RxException is thrown.ePar | The parameter ID. Allowed enum values are: | |
[in] | aValue | The value. |
|
static |
Set a parameter of type array<System::Double>
.
array<System::Double>
parameter, then a Rx::Net::RxException is thrown.ePar | The parameter ID. Allowed enum values are:
| |
[in] | aValue | The value. |
|
static |
Set a parameter of type array<System::String^>
.
array<System::String^>
parameter, then a Rx::Net::RxException is thrown.ePar | The parameter. | |
[in] | aValue | The parameter's value. |
|
static |
Receive set par. Set a Parameter of type unsiged
. This function is related to void Rx::Net::ApiLF::RxSetPar(Rx::Net::ApiLF::EPar::ID ePar,const Rx::CRxArrayUInt aValue) and sets the Value of the array on the given index.
Rx::CRxArrayUInt
parameter, then a Rx::Net::ApiLF::CRxApiException is thrown.ePar | The parameter ID. Allowed enum values are:
|
uIndex | The index of the array. |
uValue | The value to set. |
|
static |
Set a Parameter of type unsiged
. This function is related to void RxSetPar(EPar::ID ePar, const array< System::Double^> aValue) and sets the Value of the array on the given index.
Rx::CRxArrayDouble
parameter, then an Rx::Net::ApiLF::CRxApiException is thrown.ePar | The parameter ID. Allowed enum values are:
|
uIndex | The index of the array. |
dValue | The value to set. |
|
static |
Set a Parameter of type unsiged
. This function is related to void RxSetPar(EPar::ID ePar, const array< System::String^> aValue) and sets the Value of the array on the given index.
array<System::String^>
parameter, then an Rx::Net::RxException is thrown.ePar | The parameter ID. | |
uIndex | The index of the array. | |
[in] | sValue | The value to set. |