|
bool | getContinuousStrobeEnable (long deviceID, int *errorCode) |
|
unsigned long | getContinuousStrobePeriodIncrementMicroseconds (long deviceID, int *errorCode) |
|
unsigned long | getContinuousStrobePeriodMaximumMicroseconds (long deviceID, int *errorCode) |
|
unsigned long | getContinuousStrobePeriodMicroseconds (long deviceID, int *errorCode) |
|
unsigned long | getContinuousStrobePeriodMinimumMicroseconds (long deviceID, int *errorCode) |
|
unsigned long | getContinuousStrobeWidthMicroseconds (long deviceID, int *errorCode) |
|
void | setContinuousStrobeWidthMicroseconds (long deviceID, int *errorCode, unsigned long strobeWidthMicroseconds) |
|
void | setStrobeEnable (long deviceID, int *errorCode, bool strobeEnable) |
|
void | setStrobePeriodMicroseconds (long deviceID, int *errorCode, unsigned long strobePeriodMicroseconds) |
|
◆ getContinuousStrobeEnable()
bool oceandirect::api::ContinuousStrobeAPI::getContinuousStrobeEnable |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
Determine if continuous strobe is enabled or disabled.
- 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()
unsigned long oceandirect::api::ContinuousStrobeAPI::getContinuousStrobePeriodIncrementMicroseconds |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
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()
unsigned long oceandirect::api::ContinuousStrobeAPI::getContinuousStrobePeriodMaximumMicroseconds |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
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()
unsigned long oceandirect::api::ContinuousStrobeAPI::getContinuousStrobePeriodMicroseconds |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
Get the 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 continuous strobe period in microseconds.
◆ getContinuousStrobePeriodMinimumMicroseconds()
unsigned long oceandirect::api::ContinuousStrobeAPI::getContinuousStrobePeriodMinimumMicroseconds |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
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()
unsigned long oceandirect::api::ContinuousStrobeAPI::getContinuousStrobeWidthMicroseconds |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
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.
- 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.
◆ setContinuousStrobeWidthMicroseconds()
void oceandirect::api::ContinuousStrobeAPI::setContinuousStrobeWidthMicroseconds |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
unsigned long |
strobeWidthMicroseconds |
|
) |
| |
Set the continuous 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. |
strobeWidthMicroseconds | the continuous strobe width in microseconds. |
◆ setStrobeEnable()
void oceandirect::api::ContinuousStrobeAPI::setStrobeEnable |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
bool |
strobeEnable |
|
) |
| |
Enable or disable continuous 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 continuous strobe, false to disable continuous strobe. |
◆ setStrobePeriodMicroseconds()
void oceandirect::api::ContinuousStrobeAPI::setStrobePeriodMicroseconds |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
unsigned long |
strobePeriodMicroseconds |
|
) |
| |
Set the 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. |
strobePeriodMicroseconds | the continuous strobe period in microseconds. |
The documentation for this class was generated from the following file: