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

#include <NetLighthouseGainMode.h>

Inherits ManagedObject.

Public Member Functions

virtual ~NetLighthouseGainMode ()
 
virtual net_lh_enable_state_t getHighGainMode (unsigned int deviceID, int %errorCode)
 
virtual net_lh_enable_state_t getSensorGainHWState (unsigned int deviceID, int %errorCode)
 
virtual void getSensorGainMode (unsigned int deviceID, int %errorCode, net_lh_enable_state_t %highGainState, net_lh_enable_state_t %standardGainState)
 
virtual void setHighGainMode (unsigned int deviceID, int %errorCode, net_lh_enable_state_t state)
 
virtual void setSensorGainMode (unsigned int deviceID, int %errorCode, net_lh_enable_state_t highGainState, net_lh_enable_state_t standardGainState)
 

Static Public Member Functions

static NetLighthouseGainMode getInstance ()
 

Protected Member Functions

 NetLighthouseGainMode ()
 

Static Protected Attributes

static NetLighthouseGainMode gain
 

Constructor & Destructor Documentation

◆ NetLighthouseGainMode()

NetLighthouseGainMode::NetLighthouseGainMode ( )
protected

◆ ~NetLighthouseGainMode()

virtual NetLighthouse::NetLighthouseGainMode::~NetLighthouseGainMode ( )
inlinevirtual

Member Function Documentation

◆ getHighGainMode()

net_lh_enable_state_t NetLighthouseGainMode::getHighGainMode ( unsigned int deviceID,
int % errorCode )
virtual

.getHighGainMode Return the gain mode of the sensor (high or standard).

See also
setHighGainMode()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
"on" if high gain mode is enabled, "off" if standard gain mode is enabled or on error.

◆ getInstance()

NetLighthouseGainMode NetLighthouseGainMode::getInstance ( )
static

◆ getSensorGainHWState()

net_lh_enable_state_t NetLighthouseGainMode::getSensorGainHWState ( unsigned int deviceID,
int % errorCode )
virtual

.getSensorGainHWState Read the current sensor gain mode of the given device (where supported by the device).

See also
getHighGainModeState()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
"on" if high gain mode is currently enabled, "off" if standard gain mode is currently enabled.

◆ getSensorGainMode()

void NetLighthouseGainMode::getSensorGainMode ( unsigned int deviceID,
int % errorCode,
net_lh_enable_state_t % highGainState,
net_lh_enable_state_t % standardGainState )
virtual

.getSensorGainMode Read the sensor gain mode configuration of the given device. OceanNR - this device only supported one gain mode either standard gain or high gain. This function will return the calibration gain mode.

See also
setSensorGainMode()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
highGainState"on" if high gain mode support is enabled on the device, "off" otherwise.
standardGainState"on" if standard gain mode support is enabled on the device, "off" otherwise.

◆ setHighGainMode()

void NetLighthouseGainMode::setHighGainMode ( unsigned int deviceID,
int % errorCode,
net_lh_enable_state_t state )
virtual

.setHighGainMode Set the gain mode of the sensor (high or standard).

See also
getHighGainMode()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
state"on" enables high gain mode, "off" enables standard gain mode.

◆ setSensorGainMode()

void NetLighthouseGainMode::setSensorGainMode ( unsigned int deviceID,
int % errorCode,
net_lh_enable_state_t highGainState,
net_lh_enable_state_t standardGainState )
virtual

.setSensorGainMode Enables or disables support for the standard gain and high gain mode of the given device. The OceanNR unit only supported one gain mode either standard or high gain. Depending on the unit and firmware version enabling or disabling both high gain and standard gain together will return an error.

See also
getSensorGainMode()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
highGainState"on" to enable high gain mode support, "off" to disable standard gain mode support.
standardGainState"on" to enable standard gain mode support, "off" to disable high gain mode support.

Member Data Documentation

◆ gain

NetLighthouseGainMode NetLighthouse::NetLighthouseGainMode::gain
staticprotected

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