OceanDirectLighthouseC++  3.1.1
OceanDirect Lighthouse C++/C API
oceandirect::api::AutoNullingAPI Class Reference

Public Member Functions

virtual int getBaselineLevel (long deviceID, int *errorCode)
 
virtual int getFPGADigitalGain (long deviceID, int *errorCode)
 
virtual int getFPGADigitalOffset (long deviceID, int *errorCode)
 
virtual int getMaximumADCCount (long deviceID, int *errorCode)
 
virtual int getSaturationLevel (long deviceID, int *errorCode)
 

Static Public Member Functions

static AutoNullingAPIgetInstance ()
 
static void shutdown ()
 

Static Protected Attributes

static AutoNullingAPIinstance
 

Member Function Documentation

◆ getBaselineLevel()

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

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.

◆ getFPGADigitalGain()

virtual int oceandirect::api::AutoNullingAPI::getFPGADigitalGain ( long  deviceID,
int *  errorCode 
)
virtual

Get the current FPGA digital gain.

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

◆ getFPGADigitalOffset()

virtual int oceandirect::api::AutoNullingAPI::getFPGADigitalOffset ( long  deviceID,
int *  errorCode 
)
virtual

Get the current FPGA digital offset.

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

◆ getMaximumADCCount()

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

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()

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

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: