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

#include <NonLinearityAPI.h>

Public Member Functions

 NonLinearityAPI ()
 
virtual ~NonLinearityAPI ()
 
virtual int getCoeffs (long deviceID, int *errorCode, double *buffer, int maxLength)
 
virtual double getCoeffs (long deviceID, int *errorCode, int index)
 
virtual int getCoeffsCount (long deviceID, int *errorCode)
 

Static Public Member Functions

static NonLinearityAPIgetInstance ()
 
static void shutdown ()
 

Static Protected Attributes

static NonLinearityAPIinstance
 

Constructor & Destructor Documentation

◆ NonLinearityAPI()

oceandirect::api::NonLinearityAPI::NonLinearityAPI ( )

◆ ~NonLinearityAPI()

virtual oceandirect::api::NonLinearityAPI::~NonLinearityAPI ( )
virtual

Member Function Documentation

◆ getCoeffs() [1/2]

virtual int oceandirect::api::NonLinearityAPI::getCoeffs ( long deviceID,
int * errorCode,
double * buffer,
int maxLength )
virtual

Get the nonlinearity correction coefficients.

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.
bufferthe buffer to receive the nonlinearity coefficients.
maxLengththe size of the buffer.
Returns
the number nonlinearity coefficients received.

◆ getCoeffs() [2/2]

virtual double oceandirect::api::NonLinearityAPI::getCoeffs ( long deviceID,
int * errorCode,
int index )
virtual

Get the specified of nonlinearity correction coefficient.

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.
indexthe index of the desired coefficient.
Returns
the value of the specified nonlinearity coefficient.

◆ getCoeffsCount()

virtual int oceandirect::api::NonLinearityAPI::getCoeffsCount ( long deviceID,
int * errorCode )
virtual

Get the number of nonlinearity correction coefficients.

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 number of nonlinearity coefficients.

◆ getInstance()

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

◆ shutdown()

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

Member Data Documentation

◆ instance

NonLinearityAPI* oceandirect::api::NonLinearityAPI::instance
staticprotected

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