#include <SingleStrobeAPI.h>
|
| SingleStrobeAPI () |
|
virtual | ~SingleStrobeAPI () |
|
virtual unsigned long | getStrobeCycleMaximumMicroseconds (long featureID, int *errorCode) |
|
virtual unsigned long | getStrobeDelayIncrementMicroseconds (long featureID, int *errorCode) |
|
virtual unsigned long | getStrobeDelayMaximumMicroseconds (long featureID, int *errorCode) |
|
virtual unsigned long | getStrobeDelayMicroseconds (long deviceID, int *errorCode) |
|
virtual unsigned long | getStrobeDelayMinimumMicroseconds (long featureID, int *errorCode) |
|
virtual bool | getStrobeEnable (long deviceID, int *errorCode) |
|
virtual unsigned long | getStrobeWidthIncrementMicroseconds (long featureID, int *errorCode) |
|
virtual unsigned long | getStrobeWidthMaximumMicroseconds (long featureID, int *errorCode) |
|
virtual unsigned long | getStrobeWidthMicroseconds (long deviceID, int *errorCode) |
|
virtual unsigned long | getStrobeWidthMinimumMicroseconds (long featureID, int *errorCode) |
|
virtual void | setStrobeDelayMicroseconds (long deviceID, int *errorCode, unsigned long microseconds) |
|
virtual void | setStrobeEnable (long deviceID, int *errorCode, bool strobeEnable) |
|
virtual void | setStrobeWidthMicroseconds (long deviceID, int *errorCode, unsigned long microseconds) |
|
◆ SingleStrobeAPI()
oceandirect::api::SingleStrobeAPI::SingleStrobeAPI |
( |
| ) |
|
◆ ~SingleStrobeAPI()
virtual oceandirect::api::SingleStrobeAPI::~SingleStrobeAPI |
( |
| ) |
|
|
virtual |
◆ getInstance()
static SingleStrobeAPI * oceandirect::api::SingleStrobeAPI::getInstance |
( |
| ) |
|
|
static |
◆ getStrobeCycleMaximumMicroseconds()
virtual unsigned long oceandirect::api::SingleStrobeAPI::getStrobeCycleMaximumMicroseconds |
( |
long | featureID, |
|
|
int * | errorCode ) |
|
virtual |
Get the maximum strobe cycle 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 strobe cycle in microseconds.
◆ getStrobeDelayIncrementMicroseconds()
virtual unsigned long oceandirect::api::SingleStrobeAPI::getStrobeDelayIncrementMicroseconds |
( |
long | featureID, |
|
|
int * | errorCode ) |
|
virtual |
Get the strobe delay increment i.e. the minimum time between adjacent, valid strobe delays 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 strobe delay ncrement in microseconds.
◆ getStrobeDelayMaximumMicroseconds()
virtual unsigned long oceandirect::api::SingleStrobeAPI::getStrobeDelayMaximumMicroseconds |
( |
long | featureID, |
|
|
int * | errorCode ) |
|
virtual |
Get the maximum strobe delay 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 strobe delay in microseconds.
◆ getStrobeDelayMicroseconds()
virtual unsigned long oceandirect::api::SingleStrobeAPI::getStrobeDelayMicroseconds |
( |
long | deviceID, |
|
|
int * | errorCode ) |
|
virtual |
Get the strobe delay in microseconds.
- See also
- setStrobeDelayMicroseconds()
- 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 strobe delay in microseconds.
◆ getStrobeDelayMinimumMicroseconds()
virtual unsigned long oceandirect::api::SingleStrobeAPI::getStrobeDelayMinimumMicroseconds |
( |
long | featureID, |
|
|
int * | errorCode ) |
|
virtual |
Get the minimum strobe delay 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 strobe delay in microseconds.
◆ getStrobeEnable()
virtual bool oceandirect::api::SingleStrobeAPI::getStrobeEnable |
( |
long | deviceID, |
|
|
int * | errorCode ) |
|
virtual |
Determine if strobe is enabled.
- 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 strobe is enabled, false otherwise.
◆ getStrobeWidthIncrementMicroseconds()
virtual unsigned long oceandirect::api::SingleStrobeAPI::getStrobeWidthIncrementMicroseconds |
( |
long | featureID, |
|
|
int * | errorCode ) |
|
virtual |
Get the strobe width increment i.e. the minimum time between adjacent, valid strobe width 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 strobe width increment in microseconds.
◆ getStrobeWidthMaximumMicroseconds()
virtual unsigned long oceandirect::api::SingleStrobeAPI::getStrobeWidthMaximumMicroseconds |
( |
long | featureID, |
|
|
int * | errorCode ) |
|
virtual |
Get the maximum strobe width 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 strobe width in microseconds.
◆ getStrobeWidthMicroseconds()
virtual unsigned long oceandirect::api::SingleStrobeAPI::getStrobeWidthMicroseconds |
( |
long | deviceID, |
|
|
int * | errorCode ) |
|
virtual |
Get the strobe width in microseconds.
- See also
- setStrobeWidthMicroseconds()
- 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 strobe width in microseconds.
◆ getStrobeWidthMinimumMicroseconds()
virtual unsigned long oceandirect::api::SingleStrobeAPI::getStrobeWidthMinimumMicroseconds |
( |
long | featureID, |
|
|
int * | errorCode ) |
|
virtual |
Get the minimum strobe width 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 strobe width in microseconds.
◆ setStrobeDelayMicroseconds()
virtual void oceandirect::api::SingleStrobeAPI::setStrobeDelayMicroseconds |
( |
long | deviceID, |
|
|
int * | errorCode, |
|
|
unsigned long | microseconds ) |
|
virtual |
Set the strobe delay in microseconds.
- See also
- getStrobeDelayMicroseconds()
- 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. |
microseconds | the strobe delay in microseconds. |
◆ setStrobeEnable()
virtual void oceandirect::api::SingleStrobeAPI::setStrobeEnable |
( |
long | deviceID, |
|
|
int * | errorCode, |
|
|
bool | strobeEnable ) |
|
virtual |
Enable or disable strobe.
- See also
- getStrobeEnable()
- 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 strobe, false to disable strobe. |
◆ setStrobeWidthMicroseconds()
virtual void oceandirect::api::SingleStrobeAPI::setStrobeWidthMicroseconds |
( |
long | deviceID, |
|
|
int * | errorCode, |
|
|
unsigned long | microseconds ) |
|
virtual |
Set the strobe width in microseconds.
- See also
- getStrobeWidthMicroseconds()
- 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. |
microseconds | the strobe width in microseconds. |
◆ shutdown()
static void oceandirect::api::SingleStrobeAPI::shutdown |
( |
| ) |
|
|
static |
◆ instance
The documentation for this class was generated from the following file: