Inherits NetOceanDirect::ManagedObject< SingleStrobeAPI >.
|
| SingleStrobe (SingleStrobeAPI *instance) |
|
unsigned long | getStrobeDelay (long deviceID, int% errorCode) |
|
bool | getStrobeEnable (long deviceID, int% errorCode) |
|
unsigned long | getStrobeIncrementDelay (long deviceID, int% errorCode) |
|
unsigned long | getStrobeIncrementWidth (long deviceID, int% errorCode) |
|
unsigned long | getStrobeMaximumCycle (long deviceID, int% errorCode) |
|
unsigned long | getStrobeMaximumDelay (long deviceID, int% errorCode) |
|
unsigned long | getStrobeMaximumWidth (long deviceID, int% errorCode) |
|
unsigned long | getStrobeMinimumDelay (long deviceID, int% errorCode) |
|
unsigned long | getStrobeMinimumWidth (long deviceID, int% errorCode) |
|
unsigned long | getStrobeWidth (long deviceID, int% errorCode) |
|
void | setStrobeDelay (long deviceID, int% errorCode, unsigned long microseconds) |
|
void | setStrobeEnable (long deviceID, int% errorCode, bool strobeEnable) |
|
void | setStrobeWidth (long deviceID, int% errorCode, unsigned long microseconds) |
|
| ManagedObject (SingleStrobeAPI *instance) |
|
SingleStrobeAPI * | GetInstance () |
|
|
SingleStrobeAPI * | m_Instance |
|
◆ getStrobeDelay()
unsigned long SingleStrobe::getStrobeDelay |
( |
long |
deviceID, |
|
|
int% |
errorCode |
|
) |
| |
Retrieves the given device's current single strobe delay.
- See also
- setStrobeDelay()
- Parameters
-
- Returns
- current strobe delay, in microseconds also returns 0 if an error occurred.
◆ getStrobeEnable()
bool SingleStrobe::getStrobeEnable |
( |
long |
deviceID, |
|
|
int% |
errorCode |
|
) |
| |
Retrieves the given device's current strobe enable state.
- See also
- setStrobeEnable()
- Parameters
-
- Returns
- true if strobe is currently enabled, false otherwise also returns false if an error occurred.
◆ getStrobeIncrementDelay()
unsigned long SingleStrobe::getStrobeIncrementDelay |
( |
long |
deviceID, |
|
|
int% |
errorCode |
|
) |
| |
Retrieves the given device's single strobe delay increment value.
- Parameters
-
- Returns
- the device's single strobe delay increment
◆ getStrobeIncrementWidth()
unsigned long SingleStrobe::getStrobeIncrementWidth |
( |
long |
deviceID, |
|
|
int% |
errorCode |
|
) |
| |
Retrieves the given device's single strobe pulse width increment value.
- Parameters
-
- Returns
- the device's single strobe pulse width increment
◆ getStrobeMaximumCycle()
unsigned long SingleStrobe::getStrobeMaximumCycle |
( |
long |
deviceID, |
|
|
int% |
errorCode |
|
) |
| |
Retrieves the given device's maximum amount of time that the entire single strobe pulse can take. The sum of the pulse delay and width must never exceed this value. This is effectively the largest delay between the epoch and the falling edge that is allowed.
- Parameters
-
- Returns
- maximum total single strobe cycle time for the given device, in microseconds
◆ getStrobeMaximumDelay()
unsigned long SingleStrobe::getStrobeMaximumDelay |
( |
long |
deviceID, |
|
|
int% |
errorCode |
|
) |
| |
Retrieves the given device's maximum allowed single strobe delay.
- Parameters
-
- Returns
- maximum allowed single strobe delay, in microseconds
◆ getStrobeMaximumWidth()
unsigned long SingleStrobe::getStrobeMaximumWidth |
( |
long |
deviceID, |
|
|
int% |
errorCode |
|
) |
| |
Retrieves the given device's maximum allowed single strobe pulse width.
- Parameters
-
- Returns
- maximum allowed single strobe pulse width, in microseconds
◆ getStrobeMinimumDelay()
unsigned long SingleStrobe::getStrobeMinimumDelay |
( |
long |
deviceID, |
|
|
int% |
errorCode |
|
) |
| |
Retrieves the given device's minimum allowed single strobe delay.
- Parameters
-
- Returns
- minimum allowed single strobe delay, in microseconds
◆ getStrobeMinimumWidth()
unsigned long SingleStrobe::getStrobeMinimumWidth |
( |
long |
deviceID, |
|
|
int% |
errorCode |
|
) |
| |
Retrieves the given device's minimum allowed single strobe pulse width.
- Parameters
-
- Returns
- minimum allowed single strobe pulse width, in microseconds
◆ getStrobeWidth()
unsigned long SingleStrobe::getStrobeWidth |
( |
long |
deviceID, |
|
|
int% |
errorCode |
|
) |
| |
Retrieves the given device's current single strobe pulse width.
- See also
- setStrobeWidth()
- Parameters
-
- Returns
- current strobe pulse width, in microseconds also returns 0 if an error occurred.
◆ setStrobeDelay()
void SingleStrobe::setStrobeDelay |
( |
long |
deviceID, |
|
|
int% |
errorCode, |
|
|
unsigned long |
microseconds |
|
) |
| |
Sets the amount of time, in microseconds, that should elapse after a starting event before the single strobe should have a rising edge.
- See also
- getStrobeDelay()
- Parameters
-
[in] | deviceID | the device ID for the device to be configured (from OceanDirect::findDevices()) |
[out] | errorCode | set to 0 if successful, an OceanDirect error code (nonzero) otherwise |
[in] | microseconds | the new strobe delay, in microseconds |
◆ setStrobeEnable()
void SingleStrobe::setStrobeEnable |
( |
long |
deviceID, |
|
|
int% |
errorCode, |
|
|
bool |
strobeEnable |
|
) |
| |
Sets the enable status of the single strobe signal. Note that on some devices the enable control is shared with other signals (e.g. lamp enable and continuous strobe) so this may have some side-effects and changing those features may affect the single strobe as well.
- See also
- getStrobeEnable()
- Parameters
-
[in] | deviceID | the device ID for the device to be configured (from OceanDirect::findDevices()) |
[out] | errorCode | set to 0 if successful, an OceanDirect error code (nonzero) otherwise |
[in] | strobeEnable | the new strobe enable setting - true indicates enabled, false indicates disabled |
◆ setStrobeWidth()
void SingleStrobe::setStrobeWidth |
( |
long |
deviceID, |
|
|
int% |
errorCode, |
|
|
unsigned long |
microseconds |
|
) |
| |
Sets the amount of time, in microseconds, that the single strobe pulse should remain high after it begins.
- See also
- getStrobeWidth()
- Parameters
-
[in] | deviceID | the device ID for the device to be configured (from OceanDirect::findDevices()) |
[out] | errorCode | set to 0 if successful, an OceanDirect error code (nonzero) otherwise |
[in] | microseconds | the new strobe pulse width, in microseconds |
The documentation for this class was generated from the following files: