NetOceanDirectLighthouse 3.1.3
OceanDirect Lighthouse .NET API
NetLighthouse::NetLighthouseAutonulling Class Reference

#include <NetLighthouseAutonulling.h>

Inherits ManagedObject.

Public Member Functions

virtual ~NetLighthouseAutonulling ()
 
virtual unsigned int getBaselineLevel (unsigned int deviceID, int% errorCode)
 
virtual int getFPGADigitalGain (unsigned int deviceID, int% errorCode)
 
virtual int getFPGADigitalOffset (unsigned int deviceID, int% errorCode)
 
virtual unsigned int getMaximumADCCount (unsigned int deviceID, int% errorCode)
 
virtual unsigned int getSaturationLevel (unsigned int deviceID, int% errorCode)
 

Static Public Member Functions

static NetLighthouseAutonulling getInstance ()
 

Protected Member Functions

 NetLighthouseAutonulling ()
 
 NetLighthouseAutonulling (LHAutoNullingAPI *instance)
 

Static Protected Attributes

static NetLighthouseAutonulling autonulling
 

Constructor & Destructor Documentation

◆ NetLighthouseAutonulling() [1/2]

NetLighthouseAutonulling::NetLighthouseAutonulling ( )
protected

◆ NetLighthouseAutonulling() [2/2]

NetLighthouseAutonulling::NetLighthouseAutonulling ( LHAutoNullingAPI * instance)
protected

◆ ~NetLighthouseAutonulling()

virtual NetLighthouse::NetLighthouseAutonulling::~NetLighthouseAutonulling ( )
inlinevirtual

Member Function Documentation

◆ getBaselineLevel()

unsigned int NetLighthouseAutonulling::getBaselineLevel ( unsigned int deviceID,
int% errorCode )
virtual

.getBaselineLevel Return the baseline intensity value.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the baseline intensity value or 0 on error.

◆ getFPGADigitalGain()

int NetLighthouseAutonulling::getFPGADigitalGain ( unsigned int deviceID,
int% errorCode )
virtual

.getFPGADigitalGain Return the fpga digital gain value.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the digital gain value or 0 on error.

◆ getFPGADigitalOffset()

int NetLighthouseAutonulling::getFPGADigitalOffset ( unsigned int deviceID,
int% errorCode )
virtual

.getFPGADigitalOffset Return the fpga digital offset value.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the digital offset value or 0 on error.

◆ getInstance()

NetLighthouseAutonulling NetLighthouseAutonulling::getInstance ( )
static

◆ getMaximumADCCount()

unsigned int NetLighthouseAutonulling::getMaximumADCCount ( unsigned int deviceID,
int% errorCode )
virtual

.getMaximumADCCount Return the maximum value that can be returned by the analog to digital converter (ADC) on the device.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the maximum ADC value or 0 on error.

◆ getSaturationLevel()

unsigned int NetLighthouseAutonulling::getSaturationLevel ( unsigned int deviceID,
int% errorCode )
virtual

.getSaturationLevel Return the value at which the device is saturated.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the saturation value or 0 on error.

Member Data Documentation

◆ autonulling

NetLighthouseAutonulling NetLighthouse::NetLighthouseAutonulling::autonulling
staticprotected

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