#include <ContinuousStrobeAPI.h>
|
| 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) |
|
◆ ContinuousStrobeAPI()
oceandirect::api::ContinuousStrobeAPI::ContinuousStrobeAPI |
( |
| ) |
|
◆ ~ContinuousStrobeAPI()
virtual oceandirect::api::ContinuousStrobeAPI::~ContinuousStrobeAPI |
( |
| ) |
|
|
virtual |
◆ getContinuousStrobeEnable()
virtual bool oceandirect::api::ContinuousStrobeAPI::getContinuousStrobeEnable |
( |
long | deviceID, |
|
|
int * | errorCode ) |
|
virtual |
Determine if continuous strobe is enabled or disabled.
- See also
- setStrobeEnable()
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a 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
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a 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
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a 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
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a 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
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a 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
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a 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
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a 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()
◆ 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
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a 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. |
strobeWidthMicroseconds | the 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
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a 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. |
strobeEnable | true 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
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a 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. |
strobePeriodMicroseconds | the continuous strobe period in microseconds. |
◆ shutdown()
static void oceandirect::api::ContinuousStrobeAPI::shutdown |
( |
| ) |
|
|
static |
◆ instance
The documentation for this class was generated from the following file: