Inherits NetOceanDirect::ManagedObject< BackToBackAPI >.
|
| BackToBack (BackToBackAPI *instance) |
|
unsigned long | getNumberOfBackToBackScans (long deviceID, int% errorCode) |
|
void | setNumberOfBackToBackScans (long deviceID, int% errorCode, unsigned long numScans) |
|
| ManagedObject (BackToBackAPI *instance) |
|
BackToBackAPI * | GetInstance () |
|
|
BackToBackAPI * | m_Instance |
|
◆ getNumberOfBackToBackScans()
unsigned long BackToBack::getNumberOfBackToBackScans |
( |
long |
deviceID, |
|
|
int% |
errorCode |
|
) |
| |
Retrieves the given device's current back-to-back-scans configuration.
- See also
- setNumberOfBackToBackScans()
- Parameters
-
[in] | deviceID | the device ID for the device to be queried (from OceanDirect::findDevices()) |
[out] | errorCode | set to 0 if successful, an OceanDirect error code (nonzero) otherwise ERROR_NO_DEVICE if deviceID is not a valid and open deviceID ERROR_FEATURE_NOT_FOUND if device does not support this feature ERROR_TRANSFER_ERROR if data transfer to/from device fails |
- Returns
- current setting for number of back-to-back scans on specified device, or 0 if errorCode is set to a nonzero value (indicating an error)
◆ setNumberOfBackToBackScans()
void BackToBack::setNumberOfBackToBackScans |
( |
long |
deviceID, |
|
|
int% |
errorCode, |
|
|
unsigned long |
numScans |
|
) |
| |
Sets the given device's back-to-back-scans configuration to the given value.
- See also
- getNumberOfBackToBackScans()
- Parameters
-
[in] | deviceID | the device ID for the device to be queried (from OceanDirect::findDevices()) |
[out] | errorCode | set to 0 if successful, an OceanDirect error code (nonzero) otherwise ERROR_NO_DEVICE if deviceID is not a valid and open deviceID ERROR_FEATURE_NOT_FOUND if device does not support this feature ERROR_TRANSFER_ERROR if data transfer to/from device fails |
[in] | numScans | the new number of back-to-back scans for which to configure the device |
The documentation for this class was generated from the following files: