OceanDirectLighthouseC++ 3.1.3
OceanDirect Lighthouse C++/C API
oceandirect::api::BackToBackAPI Class Reference

#include <BackToBackAPI.h>

Public Member Functions

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

Static Public Member Functions

static BackToBackAPIgetInstance ()
 
static void shutdown ()
 

Static Protected Attributes

static BackToBackAPIinstance
 

Constructor & Destructor Documentation

◆ BackToBackAPI()

oceandirect::api::BackToBackAPI::BackToBackAPI ( )

◆ ~BackToBackAPI()

virtual oceandirect::api::BackToBackAPI::~BackToBackAPI ( )
virtual

Member Function Documentation

◆ getInstance()

static BackToBackAPI * oceandirect::api::BackToBackAPI::getInstance ( )
static

◆ getNumberOfBackToBackScans()

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

Get the current number of back to back scans.

See also
setNumberOfBackToBackScans()
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()

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

Set the current number of back to back scans.

See also
getNumberOfBackToBackScans()
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.

◆ shutdown()

static void oceandirect::api::BackToBackAPI::shutdown ( )
static

Member Data Documentation

◆ instance

BackToBackAPI* oceandirect::api::BackToBackAPI::instance
staticprotected

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