|
int | getCoeffs (long deviceID, int *errorCode, double *buffer, int maxLength) |
|
double | getCoeffs (long deviceID, int *errorCode, int index) |
|
int | getCoeffsCount (long deviceID, int *errorCode) |
|
◆ getCoeffs() [1/2]
int oceandirect::api::NonLinearityAPI::getCoeffs |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
double * |
buffer, |
|
|
int |
maxLength |
|
) |
| |
Get the nonlinearity correction coefficients.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
buffer | the buffer to receive the nonlinearity coefficients. |
maxLength | the size of the buffer. |
- Returns
- the number nonlinearity coefficients received.
◆ getCoeffs() [2/2]
double oceandirect::api::NonLinearityAPI::getCoeffs |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
int |
index |
|
) |
| |
Get the specified of nonlinearity correction coefficient.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
index | the index of the desired coefficient. |
- Returns
- the value of the specified nonlinearity coefficient.
◆ getCoeffsCount()
int oceandirect::api::NonLinearityAPI::getCoeffsCount |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
Get the number of nonlinearity correction coefficients.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
- Returns
- the number of nonlinearity coefficients.
The documentation for this class was generated from the following file: