#include <LHStrobeAPI.h>
|
virtual | ~LHStrobeAPI ()=default |
|
virtual lh_microseconds_t | getContinuousStrobePeriod (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual lh_microseconds_t | getContinuousStrobePeriodIncrement (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual lh_microseconds_t | getContinuousStrobePeriodMaximum (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual lh_microseconds_t | getContinuousStrobePeriodMinimum (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual lh_enable_state_t | getContinuousStrobeState (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual lh_microseconds_t | getSingleStrobeDelay (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual lh_microseconds_t | getSingleStrobeDelayIncrement (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual lh_microseconds_t | getSingleStrobeDelayMaximum (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual lh_microseconds_t | getSingleStrobeDelayMinimum (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual lh_enable_state_t | getSingleStrobeState (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual lh_microseconds_t | getSingleStrobeWidth (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual lh_microseconds_t | getSingleStrobeWidthIncrement (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual lh_microseconds_t | getSingleStrobeWidthMaximum (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual lh_microseconds_t | getSingleStrobeWidthMinimum (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
|
virtual void | setContinuousStrobePeriod (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_microseconds_t microseconds) |
|
virtual void | setContinuousStrobeState (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_enable_state_t state) |
|
virtual void | setSingleStrobeDelay (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_microseconds_t microseconds) |
|
virtual void | setSingleStrobeState (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_enable_state_t state) |
|
virtual void | setSingleStrobeWidth (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_microseconds_t microseconds) |
|
◆ ~LHStrobeAPI()
virtual oceandirect::api::LHStrobeAPI::~LHStrobeAPI |
( |
| ) |
|
|
virtualdefault |
◆ getContinuousStrobePeriod()
.getContinuousStrobePeriod Return the continuous strobe period in microseconds.
- See also
- setContinuousStrobePeriod()
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the continuous strobe period in microseconds or 0 on error.
◆ getContinuousStrobePeriodIncrement()
.getContinuousStrobePeriodIncrement Return the continuous strobe period increment in microseconds. The increment is the minimum value between two adjacent (valid) continuous strobe period values.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the continuous strobe period increment in microseconds or 0 on error.
◆ getContinuousStrobePeriodMaximum()
.getContinuousStrobePeriodMaximum Return the maximum continuous strobe period in microseconds.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the maximum continuous strobe period in microseconds or 0 on error.
◆ getContinuousStrobePeriodMinimum()
.getContinuousStrobePeriodMinimum Return the minimum continuous strobe period in microseconds.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the minimum continuous strobe period in microseconds or 0 on error.
◆ getContinuousStrobeState()
.getContinuousStrobeState Determine if continuous strobe is enabled or disabled on the device.
- See also
- setContinuousStrobeState()
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- state "on" if continuous strobe is enabled, "off" if continuous strobe is disabled or on error.
◆ getSingleStrobeDelay()
.getSingleStrobeDelay Get the single strobe delay in microseconds.
- See also
- setSingleStrobeDelay()
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the current single strobe delay in microseconds or 0 on error.
◆ getSingleStrobeDelayIncrement()
.getSingleStrobeDelayIncrement Return the single strobe delay increment in microseconds. The increment is the minimum value between two adjacent (valid) single strobe delay values.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the single strobe delay increment in microseconds or 0 on error.
◆ getSingleStrobeDelayMaximum()
.getSingleStrobeDelayMaximum Get the maximum single strobe delay in microseconds.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the maximum single strobe delay in microseconds or 0 on error.
◆ getSingleStrobeDelayMinimum()
.getSingleStrobeDelayMinimum Get the minimum single strobe delay in microseconds.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the minimum single strobe delay in microseconds or 0 on error.
◆ getSingleStrobeState()
.getSingleStrobeState Determine if single strobe is enabled or disabled on the device.
- See also
- setSingleStrobeState()
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- state "on" if single strobe is enabled, "off" if single strobe is disabled or on error.
◆ getSingleStrobeWidth()
.getSingleStrobeWidth Get the single strobe width in microseconds.
- See also
- setSingleStrobeWidth()
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the current single strobe width in microseconds or 0 on error.
◆ getSingleStrobeWidthIncrement()
.getSingleStrobeWidthIncrement Return the single strobe width increment in microseconds. The increment is the minimum value between two adjacent (valid) single strobe width values.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the single strobe width increment in microseconds or 0 on error.
◆ getSingleStrobeWidthMaximum()
.getSingleStrobeWidthMaximum Get the maximum single strobe width in microseconds.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the maximum single strobe width in microseconds or 0 on error.
◆ getSingleStrobeWidthMinimum()
.getSingleStrobeWidthMinimum Get the minimum single strobe width in microseconds.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the minimum single strobe width in microseconds or 0 on error.
◆ setContinuousStrobePeriod()
.setContinuousStrobePeriod Set the continuous strobe period in microseconds.
- See also
- getContinuousStrobePeriod
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
microseconds | the desired continuous strobe period in microseconds. |
◆ setContinuousStrobeState()
.setContinuousStrobeState Enable or disable continuous strobe on the device.
- See also
- getContinuousStrobeState()
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
state | "on" to enable continuous strobe, "off" to disable continuous strobe. |
◆ setSingleStrobeDelay()
.setSingleStrobeDelay Set the single strobe delay in microseconds.
- See also
- getSingleStrobeDelay()
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
microseconds | the desired single strobe delay in microseconds. |
◆ setSingleStrobeState()
.setSingleStrobeState Enable or disable single strobe on the device.
- See also
- getSingleStrobeState()
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
state | "on" to enable single strobe, "off" to disable single strobe. |
◆ setSingleStrobeWidth()
.setSingleStrobeWidth Set the single strobe width in microseconds.
- See also
- getSingleStrobeWidth()
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
microseconds | the desired single strobe width in microseconds. |
The documentation for this class was generated from the following file: