NetOceanDirect  2.4.0
OceanDirect .NET API
Public Member Functions | Static Public Member Functions | List of all members
NetOceanDirect::SingleStrobe Class Reference

Inherits NetOceanDirect::ManagedObject< SingleStrobeAPI >.

Public Member Functions

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)
 
- Public Member Functions inherited from NetOceanDirect::ManagedObject< SingleStrobeAPI >
 ManagedObject (SingleStrobeAPI *instance)
 
SingleStrobeAPI * GetInstance ()
 

Static Public Member Functions

static SingleStrobe getInstance ()
 

Additional Inherited Members

- Protected Attributes inherited from NetOceanDirect::ManagedObject< SingleStrobeAPI >
SingleStrobeAPI * m_Instance
 

Member Function Documentation

◆ getStrobeDelay()

unsigned long SingleStrobe::getStrobeDelay ( long  deviceID,
int%  errorCode 
)

Retrieves the given device's current single strobe delay.

Parameters
[in]deviceIDthe device ID for the device to be queried (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise
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.

Parameters
[in]deviceIDthe device ID for the device to be queried (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise
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
[in]deviceIDthe device ID for the device to be queried (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise
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
[in]deviceIDthe device ID for the device to be queried (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise
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
[in]deviceIDthe device ID for the device to be queried (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise
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
[in]deviceIDthe device ID for the device to be queried (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise
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
[in]deviceIDthe device ID for the device to be queried (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise
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
[in]deviceIDthe device ID for the device to be queried (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise
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
[in]deviceIDthe device ID for the device to be queried (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise
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.

Parameters
[in]deviceIDthe device ID for the device to be queried (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise
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.

Parameters
[in]deviceIDthe device ID for the device to be configured (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise
[in]microsecondsthe 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.

Parameters
[in]deviceIDthe device ID for the device to be configured (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise
[in]strobeEnablethe 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.

Parameters
[in]deviceIDthe device ID for the device to be configured (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise
[in]microsecondsthe new strobe pulse width, in microseconds

The documentation for this class was generated from the following files: