OceanDirectLighthouse 3.1.3
OceanDirect Lighthouse C++/C API
oceandirect::api::LHGainModeAPI Class Reference

#include <LHGainModeAPI.h>

Public Member Functions

virtual ~LHGainModeAPI ()=default
 
virtual lh_enable_state_t getHighGainMode (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_enable_state_t getSensorGainHWState (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual void getSensorGainMode (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_enable_state_t &highGainState, lh_enable_state_t &standardGainState)
 
virtual void setHighGainMode (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_enable_state_t state)
 
virtual void setSensorGainMode (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_enable_state_t highGainState, lh_enable_state_t standardGainState)
 

Constructor & Destructor Documentation

◆ ~LHGainModeAPI()

virtual oceandirect::api::LHGainModeAPI::~LHGainModeAPI ( )
virtualdefault

Member Function Documentation

◆ getHighGainMode()

virtual lh_enable_state_t oceandirect::api::LHGainModeAPI::getHighGainMode ( lh_device_id_t deviceID,
lh_error_code_t * 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.

◆ getSensorGainHWState()

virtual lh_enable_state_t oceandirect::api::LHGainModeAPI::getSensorGainHWState ( lh_device_id_t deviceID,
lh_error_code_t * 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()

virtual void oceandirect::api::LHGainModeAPI::getSensorGainMode ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
lh_enable_state_t & highGainState,
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()

virtual void oceandirect::api::LHGainModeAPI::setHighGainMode ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
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()

virtual void oceandirect::api::LHGainModeAPI::setSensorGainMode ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
lh_enable_state_t highGainState,
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.

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