NetOceanDirect 3.1.3
OceanDirect .NET API
NetOceanDirect::BackToBack Class Reference

#include <BackToBack.h>

Inherits NetOceanDirect::ManagedObject< BackToBackAPI >.

Public Member Functions

 BackToBack (BackToBackAPI *instance)
 
virtual ~BackToBack ()
 
unsigned long getNumberOfBackToBackScans (long deviceID, int% errorCode)
 
void setNumberOfBackToBackScans (long deviceID, int% errorCode, unsigned long numScans)
 
- Public Member Functions inherited from NetOceanDirect::ManagedObject< BackToBackAPI >
 ManagedObject (BackToBackAPI *instance)
 
 !ManagedObject ()
 
virtual ~ManagedObject ()
 
BackToBackAPI * GetInstance ()
 

Static Public Member Functions

static BackToBack getInstance ()
 

Protected Member Functions

 BackToBack ()
 

Static Protected Attributes

static BackToBack dbuffer
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ BackToBack() [1/2]

BackToBack::BackToBack ( )
protected

◆ BackToBack() [2/2]

BackToBack::BackToBack ( BackToBackAPI * instance)

◆ ~BackToBack()

virtual NetOceanDirect::BackToBack::~BackToBack ( )
inlinevirtual

Member Function Documentation

◆ getInstance()

BackToBack BackToBack::getInstance ( )
static

◆ 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]deviceIDthe device ID for the device to be queried (from OceanDirect::findDevices())
[out]errorCodeset 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]deviceIDthe device ID for the device to be queried (from OceanDirect::findDevices())
[out]errorCodeset 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]numScansthe new number of back-to-back scans for which to configure the device

Member Data Documentation

◆ dbuffer

BackToBack NetOceanDirect::BackToBack::dbuffer
staticprotected

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