OceanDirectLighthouseC++ 3.1.3
OceanDirect Lighthouse C++/C API
oceandirect::api::ContinuousStrobeAPI Class Reference

#include <ContinuousStrobeAPI.h>

Public Member Functions

 ContinuousStrobeAPI ()
 
virtual ~ContinuousStrobeAPI ()
 
virtual bool getContinuousStrobeEnable (long deviceID, int *errorCode)
 
virtual unsigned long getContinuousStrobePeriodIncrementMicroseconds (long deviceID, int *errorCode)
 
virtual unsigned long getContinuousStrobePeriodMaximumMicroseconds (long deviceID, int *errorCode)
 
virtual unsigned long getContinuousStrobePeriodMicroseconds (long deviceID, int *errorCode)
 
virtual unsigned long getContinuousStrobePeriodMinimumMicroseconds (long deviceID, int *errorCode)
 
virtual unsigned long getContinuousStrobeWidthMicroseconds (long deviceID, int *errorCode)
 
virtual void setContinuousStrobeWidthMicroseconds (long deviceID, int *errorCode, unsigned long strobeWidthMicroseconds)
 
virtual void setStrobeEnable (long deviceID, int *errorCode, bool strobeEnable)
 
virtual void setStrobePeriodMicroseconds (long deviceID, int *errorCode, unsigned long strobePeriodMicroseconds)
 

Static Public Member Functions

static ContinuousStrobeAPIgetInstance ()
 
static void shutdown ()
 

Static Protected Attributes

static ContinuousStrobeAPIinstance
 

Constructor & Destructor Documentation

◆ ContinuousStrobeAPI()

oceandirect::api::ContinuousStrobeAPI::ContinuousStrobeAPI ( )

◆ ~ContinuousStrobeAPI()

virtual oceandirect::api::ContinuousStrobeAPI::~ContinuousStrobeAPI ( )
virtual

Member Function Documentation

◆ getContinuousStrobeEnable()

virtual bool oceandirect::api::ContinuousStrobeAPI::getContinuousStrobeEnable ( long deviceID,
int * errorCode )
virtual

Determine if continuous strobe is enabled or disabled.

See also
setStrobeEnable()
Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
Returns
true if continuous strobe is enabled, false otherwise.

◆ getContinuousStrobePeriodIncrementMicroseconds()

virtual unsigned long oceandirect::api::ContinuousStrobeAPI::getContinuousStrobePeriodIncrementMicroseconds ( long deviceID,
int * errorCode )
virtual

Get the continuous strobe period increment in microseconds i.e. the minimum time between adjacent valid continuous strobe period.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
Returns
the continuous strobe period increment in microseconds.

◆ getContinuousStrobePeriodMaximumMicroseconds()

virtual unsigned long oceandirect::api::ContinuousStrobeAPI::getContinuousStrobePeriodMaximumMicroseconds ( long deviceID,
int * errorCode )
virtual

Get the maximum continuous strobe period in microseconds.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
Returns
the maximum continuous strobe period in microseconds.

◆ getContinuousStrobePeriodMicroseconds()

virtual unsigned long oceandirect::api::ContinuousStrobeAPI::getContinuousStrobePeriodMicroseconds ( long deviceID,
int * errorCode )
virtual

Get the continuous strobe period in microseconds.

See also
setStrobePeriodMicroseconds()
Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
Returns
the continuous strobe period in microseconds.

◆ getContinuousStrobePeriodMinimumMicroseconds()

virtual unsigned long oceandirect::api::ContinuousStrobeAPI::getContinuousStrobePeriodMinimumMicroseconds ( long deviceID,
int * errorCode )
virtual

Get the minimum continuous strobe period in microseconds.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
Returns
the minimum continuous strobe period in microseconds.

◆ getContinuousStrobeWidthMicroseconds()

virtual unsigned long oceandirect::api::ContinuousStrobeAPI::getContinuousStrobeWidthMicroseconds ( long deviceID,
int * errorCode )
virtual

Get the maximum continuous strobe period in microseconds.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
Returns
the maximum continuous strobe period in microseconds. Get the continuous strobe width in microseconds.
See also
setContinuousStrobeWidthMicroseconds()
Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
Returns
the continuous strobe width in microseconds.

◆ getInstance()

static ContinuousStrobeAPI * oceandirect::api::ContinuousStrobeAPI::getInstance ( )
static

◆ setContinuousStrobeWidthMicroseconds()

virtual void oceandirect::api::ContinuousStrobeAPI::setContinuousStrobeWidthMicroseconds ( long deviceID,
int * errorCode,
unsigned long strobeWidthMicroseconds )
virtual

Set the continuous strobe width in microseconds.

See also
getContinuousStrobeWidthMicroseconds()
Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
strobeWidthMicrosecondsthe continuous strobe width in microseconds.

◆ setStrobeEnable()

virtual void oceandirect::api::ContinuousStrobeAPI::setStrobeEnable ( long deviceID,
int * errorCode,
bool strobeEnable )
virtual

Enable or disable continuous strobe.

See also
getContinuousStrobeEnable()
Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
strobeEnabletrue to enable continuous strobe, false to disable continuous strobe.

◆ setStrobePeriodMicroseconds()

virtual void oceandirect::api::ContinuousStrobeAPI::setStrobePeriodMicroseconds ( long deviceID,
int * errorCode,
unsigned long strobePeriodMicroseconds )
virtual

Set the continuous strobe period in microseconds.

See also
getContinuousStrobePeriodMicroseconds()
Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
strobePeriodMicrosecondsthe continuous strobe period in microseconds.

◆ shutdown()

static void oceandirect::api::ContinuousStrobeAPI::shutdown ( )
static

Member Data Documentation

◆ instance

ContinuousStrobeAPI* oceandirect::api::ContinuousStrobeAPI::instance
staticprotected

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