OceanDirect  2.4.0
OceanDirect C++/C API
oceandirect::api::BackToBackAPI Class Reference

Public Member Functions

unsigned long getNumberOfBackToBackScans (long deviceID, int *errorCode)
 
void setNumberOfBackToBackScans (long deviceID, int *errorCode, unsigned long numScans)
 

Static Public Member Functions

static BackToBackAPIgetInstance ()
 
static void shutdown ()
 

Member Function Documentation

◆ getNumberOfBackToBackScans()

unsigned long oceandirect::api::BackToBackAPI::getNumberOfBackToBackScans ( long  deviceID,
int *  errorCode 
)

Get the current number of back to back scans.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
Returns
the current number of back to back scans.

◆ setNumberOfBackToBackScans()

void oceandirect::api::BackToBackAPI::setNumberOfBackToBackScans ( long  deviceID,
int *  errorCode,
unsigned long  numScans 
)

Set the current number of back to back scans.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
numScansthe desired number of back to back scans.

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