|
unsigned long | getStrobeCycleMaximumMicroseconds (long featureID, int *errorCode) |
|
unsigned long | getStrobeDelayIncrementMicroseconds (long featureID, int *errorCode) |
|
unsigned long | getStrobeDelayMaximumMicroseconds (long featureID, int *errorCode) |
|
unsigned long | getStrobeDelayMicroseconds (long deviceID, int *errorCode) |
|
unsigned long | getStrobeDelayMinimumMicroseconds (long featureID, int *errorCode) |
|
bool | getStrobeEnable (long deviceID, int *errorCode) |
|
unsigned long | getStrobeWidthIncrementMicroseconds (long featureID, int *errorCode) |
|
unsigned long | getStrobeWidthMaximumMicroseconds (long featureID, int *errorCode) |
|
unsigned long | getStrobeWidthMicroseconds (long deviceID, int *errorCode) |
|
unsigned long | getStrobeWidthMinimumMicroseconds (long featureID, int *errorCode) |
|
void | setStrobeDelayMicroseconds (long deviceID, int *errorCode, unsigned long microseconds) |
|
void | setStrobeEnable (long deviceID, int *errorCode, bool strobeEnable) |
|
void | setStrobeWidthMicroseconds (long deviceID, int *errorCode, unsigned long microseconds) |
|
◆ getStrobeCycleMaximumMicroseconds()
unsigned long oceandirect::api::SingleStrobeAPI::getStrobeCycleMaximumMicroseconds |
( |
long |
featureID, |
|
|
int * |
errorCode |
|
) |
| |
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()
unsigned long oceandirect::api::SingleStrobeAPI::getStrobeDelayIncrementMicroseconds |
( |
long |
featureID, |
|
|
int * |
errorCode |
|
) |
| |
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()
unsigned long oceandirect::api::SingleStrobeAPI::getStrobeDelayMaximumMicroseconds |
( |
long |
featureID, |
|
|
int * |
errorCode |
|
) |
| |
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()
unsigned long oceandirect::api::SingleStrobeAPI::getStrobeDelayMicroseconds |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
Get the 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 strobe delay in microseconds.
◆ getStrobeDelayMinimumMicroseconds()
unsigned long oceandirect::api::SingleStrobeAPI::getStrobeDelayMinimumMicroseconds |
( |
long |
featureID, |
|
|
int * |
errorCode |
|
) |
| |
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()
bool oceandirect::api::SingleStrobeAPI::getStrobeEnable |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
Determine if strobe is enabled.
- 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()
unsigned long oceandirect::api::SingleStrobeAPI::getStrobeWidthIncrementMicroseconds |
( |
long |
featureID, |
|
|
int * |
errorCode |
|
) |
| |
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()
unsigned long oceandirect::api::SingleStrobeAPI::getStrobeWidthMaximumMicroseconds |
( |
long |
featureID, |
|
|
int * |
errorCode |
|
) |
| |
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()
unsigned long oceandirect::api::SingleStrobeAPI::getStrobeWidthMicroseconds |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
Get the 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 in microseconds.
◆ getStrobeWidthMinimumMicroseconds()
unsigned long oceandirect::api::SingleStrobeAPI::getStrobeWidthMinimumMicroseconds |
( |
long |
featureID, |
|
|
int * |
errorCode |
|
) |
| |
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()
void oceandirect::api::SingleStrobeAPI::setStrobeDelayMicroseconds |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
unsigned long |
microseconds |
|
) |
| |
Set the 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. |
microseconds | the strobe delay in microseconds. |
◆ setStrobeEnable()
void oceandirect::api::SingleStrobeAPI::setStrobeEnable |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
bool |
strobeEnable |
|
) |
| |
Enable or disable strobe.
- 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()
void oceandirect::api::SingleStrobeAPI::setStrobeWidthMicroseconds |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
unsigned long |
microseconds |
|
) |
| |
Set the 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. |
microseconds | the strobe width in microseconds. |
The documentation for this class was generated from the following file: