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

#include <AutoNullingAPI.h>

Public Member Functions

 AutoNullingAPI ()
 
virtual ~AutoNullingAPI ()
 
virtual int getBaselineLevel (long deviceID, int *errorCode)
 
virtual void getBaselineLevelConstraints (long deviceID, int *errorCode, unsigned int *minDAC, unsigned int *maxDAC, float *minVolts, float *maxVolts)
 
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)
 
virtual void getSaturationLevelConstraints (long deviceID, int *errorCode, unsigned int *minDAC, unsigned int *maxDAC, float *minVolts, float *maxVolts)
 

Static Public Member Functions

static AutoNullingAPIgetInstance ()
 
static void shutdown ()
 

Static Protected Attributes

static AutoNullingAPIinstance
 

Constructor & Destructor Documentation

◆ AutoNullingAPI()

oceandirect::api::AutoNullingAPI::AutoNullingAPI ( )

◆ ~AutoNullingAPI()

virtual oceandirect::api::AutoNullingAPI::~AutoNullingAPI ( )
virtual

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.

◆ getBaselineLevelConstraints()

virtual void oceandirect::api::AutoNullingAPI::getBaselineLevelConstraints ( long deviceID,
int * errorCode,
unsigned int * minDAC,
unsigned int * maxDAC,
float * minVolts,
float * maxVolts )
virtual

Get autonulling constraints value for baseline settings. This command only applies to Ocean FX/HDX units.

Parameters
deviceIdthe device ID for the device to be configured.
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;
minDACminimum offset DAC value.
maxDACmaximum offset DAC value.
minVoltsminimum offset volt value.
maxVoltsmaximum offset volt value.

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

◆ getInstance()

static AutoNullingAPI * oceandirect::api::AutoNullingAPI::getInstance ( )
static

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

◆ getSaturationLevelConstraints()

virtual void oceandirect::api::AutoNullingAPI::getSaturationLevelConstraints ( long deviceID,
int * errorCode,
unsigned int * minDAC,
unsigned int * maxDAC,
float * minVolts,
float * maxVolts )
virtual

Get autonulling constraints value for saturation settings. This command only applies to Ocean FX/HDX units.

Parameters
deviceIdthe device ID for the device to be configured.
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;
minDACminimum saturation DAC value.
maxDACmaximum saturation DAC value.
minVoltsminimum saturation volt value.
maxVoltsmaximum saturation volt value.

◆ shutdown()

static void oceandirect::api::AutoNullingAPI::shutdown ( )
static

Member Data Documentation

◆ instance

AutoNullingAPI* oceandirect::api::AutoNullingAPI::instance
staticprotected

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