NetOceanDirectLighthouse  3.1.1
OceanDirect Lighthouse .NET API
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes | List of all members
NetLighthouse::NetLighthouseAutonulling Class Reference

Inherits ManagedObject.

Public Member Functions

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 (LHAutoNullingAPI *instance)
 

Static Protected Attributes

static NetLighthouseAutonulling autonulling
 

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.

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

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