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

Inherits NetOceanDirect::ManagedObject< ContinuousStrobeAPI >.

Public Member Functions

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 setContinuousStrobeEnable (long deviceID, int %errorCode, bool strobeEnable)
 
void setContinuousStrobePeriodMicroseconds (long deviceID, int %errorCode, unsigned long strobePeriodMicroseconds)
 
void setContinuousStrobeWidthMicroseconds (long deviceID, int %errorCode, unsigned long strobeWidthMicroseconds)
 
- Public Member Functions inherited from NetOceanDirect::ManagedObject< ContinuousStrobeAPI >
 ManagedObject (ContinuousStrobeAPI *instance)
 
ContinuousStrobeAPI * GetInstance ()
 

Static Public Member Functions

static ContinuousStrobe getInstance ()
 

Additional Inherited Members

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

Member Function Documentation

◆ getContinuousStrobeEnable()

bool ContinuousStrobe::getContinuousStrobeEnable ( long  deviceID,
int %  errorCode 
)

Determine if the continuous strobe feature is turned on or off.

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
Returns
true if the continuous strobe feature is enabled, false otherwise.

◆ getContinuousStrobePeriodIncrementMicroseconds()

unsigned long ContinuousStrobe::getContinuousStrobePeriodIncrementMicroseconds ( long  deviceID,
int %  errorCode 
)

Get the increment for the continuous strobe period for the specified device i.e. the minimum allowable difference between continuous strobe periods, in microseconds.

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
Returns
the continuous strobe period increment in microseconds.

◆ getContinuousStrobePeriodMaximumMicroseconds()

unsigned long ContinuousStrobe::getContinuousStrobePeriodMaximumMicroseconds ( long  deviceID,
int %  errorCode 
)

Get the maximum allowable continuous strobe period for the specified device.

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
Returns
the maximum continuous strobe period in microseconds.

◆ getContinuousStrobePeriodMicroseconds()

unsigned long ContinuousStrobe::getContinuousStrobePeriodMicroseconds ( long  deviceID,
int %  errorCode 
)

Gets the given device's continuous strobe period, which is the amount of time required for one complete strobe cycle (low and high).

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
Returns
the continuous strobe period in microseconds.

◆ getContinuousStrobePeriodMinimumMicroseconds()

unsigned long ContinuousStrobe::getContinuousStrobePeriodMinimumMicroseconds ( long  deviceID,
int %  errorCode 
)

Get the minimum allowable continuous strobe period for the specified device.

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
Returns
the minimum continuous strobe period in microseconds.

◆ getContinuousStrobeWidthMicroseconds()

unsigned long ContinuousStrobe::getContinuousStrobeWidthMicroseconds ( long  deviceID,
int %  errorCode 
)

Get the width of the continuous strobe period for the specified device.

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
Returns
the width of the continuous strobe period in microseconds.

◆ setContinuousStrobeEnable()

void ContinuousStrobe::setContinuousStrobeEnable ( long  deviceID,
int %  errorCode,
bool  strobeEnable 
)

Enables/disables the continuous strobe output of the given device.

Parameters
[in]deviceIDthe device ID for the device to be configured (from OceanDirect::findDevices())
[in]strobeEnablethe new strobe enable setting to be applied (true indicates enable, false indicates disable)

◆ setContinuousStrobePeriodMicroseconds()

void ContinuousStrobe::setContinuousStrobePeriodMicroseconds ( long  deviceID,
int %  errorCode,
unsigned long  strobePeriodMicroseconds 
)

Sets the given device's continuous strobe period, which is the amount of time required for one complete strobe cycle (low and high).

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]strobePeriodMicrosecondsthe new continuous strobe period setting, in microseconds

◆ setContinuousStrobeWidthMicroseconds()

void ContinuousStrobe::setContinuousStrobeWidthMicroseconds ( long  deviceID,
int %  errorCode,
unsigned long  strobeWidthMicroseconds 
)

Set the width of the continuous strobe period for the specified device.

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]strobeWidthMicrosecondsthe new continuous strobe width setting, in microseconds
Returns
the continuous strobe period width in microseconds.

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