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

#include <LHStrobeAPI.h>

Public Member Functions

virtual ~LHStrobeAPI ()=default
 
virtual lh_microseconds_t getContinuousStrobePeriod (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_microseconds_t getContinuousStrobePeriodIncrement (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_microseconds_t getContinuousStrobePeriodMaximum (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_microseconds_t getContinuousStrobePeriodMinimum (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_enable_state_t getContinuousStrobeState (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_microseconds_t getSingleStrobeDelay (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_microseconds_t getSingleStrobeDelayIncrement (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_microseconds_t getSingleStrobeDelayMaximum (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_microseconds_t getSingleStrobeDelayMinimum (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_enable_state_t getSingleStrobeState (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_microseconds_t getSingleStrobeWidth (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_microseconds_t getSingleStrobeWidthIncrement (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_microseconds_t getSingleStrobeWidthMaximum (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_microseconds_t getSingleStrobeWidthMinimum (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual void setContinuousStrobePeriod (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_microseconds_t microseconds)
 
virtual void setContinuousStrobeState (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_enable_state_t state)
 
virtual void setSingleStrobeDelay (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_microseconds_t microseconds)
 
virtual void setSingleStrobeState (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_enable_state_t state)
 
virtual void setSingleStrobeWidth (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_microseconds_t microseconds)
 

Constructor & Destructor Documentation

◆ ~LHStrobeAPI()

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

Member Function Documentation

◆ getContinuousStrobePeriod()

virtual lh_microseconds_t oceandirect::api::LHStrobeAPI::getContinuousStrobePeriod ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getContinuousStrobePeriod Return the continuous strobe period in microseconds.

See also
setContinuousStrobePeriod()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the continuous strobe period in microseconds or 0 on error.

◆ getContinuousStrobePeriodIncrement()

virtual lh_microseconds_t oceandirect::api::LHStrobeAPI::getContinuousStrobePeriodIncrement ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getContinuousStrobePeriodIncrement Return the continuous strobe period increment in microseconds. The increment is the minimum value between two adjacent (valid) continuous strobe period values.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the continuous strobe period increment in microseconds or 0 on error.

◆ getContinuousStrobePeriodMaximum()

virtual lh_microseconds_t oceandirect::api::LHStrobeAPI::getContinuousStrobePeriodMaximum ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getContinuousStrobePeriodMaximum Return the maximum continuous strobe period in microseconds.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the maximum continuous strobe period in microseconds or 0 on error.

◆ getContinuousStrobePeriodMinimum()

virtual lh_microseconds_t oceandirect::api::LHStrobeAPI::getContinuousStrobePeriodMinimum ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getContinuousStrobePeriodMinimum Return the minimum continuous strobe period in microseconds.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the minimum continuous strobe period in microseconds or 0 on error.

◆ getContinuousStrobeState()

virtual lh_enable_state_t oceandirect::api::LHStrobeAPI::getContinuousStrobeState ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getContinuousStrobeState Determine if continuous strobe is enabled or disabled on the device.

See also
setContinuousStrobeState()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
state "on" if continuous strobe is enabled, "off" if continuous strobe is disabled or on error.

◆ getSingleStrobeDelay()

virtual lh_microseconds_t oceandirect::api::LHStrobeAPI::getSingleStrobeDelay ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getSingleStrobeDelay Get the single strobe delay in microseconds.

See also
setSingleStrobeDelay()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the current single strobe delay in microseconds or 0 on error.

◆ getSingleStrobeDelayIncrement()

virtual lh_microseconds_t oceandirect::api::LHStrobeAPI::getSingleStrobeDelayIncrement ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getSingleStrobeDelayIncrement Return the single strobe delay increment in microseconds. The increment is the minimum value between two adjacent (valid) single strobe delay values.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the single strobe delay increment in microseconds or 0 on error.

◆ getSingleStrobeDelayMaximum()

virtual lh_microseconds_t oceandirect::api::LHStrobeAPI::getSingleStrobeDelayMaximum ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getSingleStrobeDelayMaximum Get the maximum single strobe delay in microseconds.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the maximum single strobe delay in microseconds or 0 on error.

◆ getSingleStrobeDelayMinimum()

virtual lh_microseconds_t oceandirect::api::LHStrobeAPI::getSingleStrobeDelayMinimum ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getSingleStrobeDelayMinimum Get the minimum single strobe delay in microseconds.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the minimum single strobe delay in microseconds or 0 on error.

◆ getSingleStrobeState()

virtual lh_enable_state_t oceandirect::api::LHStrobeAPI::getSingleStrobeState ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getSingleStrobeState Determine if single strobe is enabled or disabled on the device.

See also
setSingleStrobeState()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
state "on" if single strobe is enabled, "off" if single strobe is disabled or on error.

◆ getSingleStrobeWidth()

virtual lh_microseconds_t oceandirect::api::LHStrobeAPI::getSingleStrobeWidth ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getSingleStrobeWidth Get the single strobe width in microseconds.

See also
setSingleStrobeWidth()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the current single strobe width in microseconds or 0 on error.

◆ getSingleStrobeWidthIncrement()

virtual lh_microseconds_t oceandirect::api::LHStrobeAPI::getSingleStrobeWidthIncrement ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getSingleStrobeWidthIncrement Return the single strobe width increment in microseconds. The increment is the minimum value between two adjacent (valid) single strobe width values.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the single strobe width increment in microseconds or 0 on error.

◆ getSingleStrobeWidthMaximum()

virtual lh_microseconds_t oceandirect::api::LHStrobeAPI::getSingleStrobeWidthMaximum ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getSingleStrobeWidthMaximum Get the maximum single strobe width in microseconds.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the maximum single strobe width in microseconds or 0 on error.

◆ getSingleStrobeWidthMinimum()

virtual lh_microseconds_t oceandirect::api::LHStrobeAPI::getSingleStrobeWidthMinimum ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getSingleStrobeWidthMinimum Get the minimum single strobe width in microseconds.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the minimum single strobe width in microseconds or 0 on error.

◆ setContinuousStrobePeriod()

virtual void oceandirect::api::LHStrobeAPI::setContinuousStrobePeriod ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
lh_microseconds_t microseconds )
virtual

.setContinuousStrobePeriod Set the continuous strobe period in microseconds.

See also
getContinuousStrobePeriod
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
microsecondsthe desired continuous strobe period in microseconds.

◆ setContinuousStrobeState()

virtual void oceandirect::api::LHStrobeAPI::setContinuousStrobeState ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
lh_enable_state_t state )
virtual

.setContinuousStrobeState Enable or disable continuous strobe on the device.

See also
getContinuousStrobeState()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
state"on" to enable continuous strobe, "off" to disable continuous strobe.

◆ setSingleStrobeDelay()

virtual void oceandirect::api::LHStrobeAPI::setSingleStrobeDelay ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
lh_microseconds_t microseconds )
virtual

.setSingleStrobeDelay Set the single strobe delay in microseconds.

See also
getSingleStrobeDelay()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
microsecondsthe desired single strobe delay in microseconds.

◆ setSingleStrobeState()

virtual void oceandirect::api::LHStrobeAPI::setSingleStrobeState ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
lh_enable_state_t state )
virtual

.setSingleStrobeState Enable or disable single strobe on the device.

See also
getSingleStrobeState()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
state"on" to enable single strobe, "off" to disable single strobe.

◆ setSingleStrobeWidth()

virtual void oceandirect::api::LHStrobeAPI::setSingleStrobeWidth ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
lh_microseconds_t microseconds )
virtual

.setSingleStrobeWidth Set the single strobe width in microseconds.

See also
getSingleStrobeWidth()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
microsecondsthe desired single strobe width in microseconds.

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