OceanDirect  2.4.0
OceanDirect C++/C API
oceandirect::api::AutoNullingAPI Class Reference

Public Member Functions

int getBaselineLevel (long deviceID, int *error_code)
 
int getMaximumADCCount (long deviceID, int *error_code)
 
int getSaturationLevel (long deviceID, int *error_code)
 

Static Public Member Functions

static AutoNullingAPIgetInstance ()
 
static void shutdown ()
 

Member Function Documentation

◆ getBaselineLevel()

int oceandirect::api::AutoNullingAPI::getBaselineLevel ( long  deviceID,
int *  error_code 
)

Get the current baseline level.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea 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 baseline level.

◆ getMaximumADCCount()

int oceandirect::api::AutoNullingAPI::getMaximumADCCount ( long  deviceID,
int *  error_code 
)

Get the maximum ADC value.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea 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 maximum ADC value.

◆ getSaturationLevel()

int oceandirect::api::AutoNullingAPI::getSaturationLevel ( long  deviceID,
int *  error_code 
)

Get the current saturation level.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea 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 saturation level.

The documentation for this class was generated from the following file: