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

#include <NonLinearity.h>

Inherits NetOceanDirect::ManagedObject< NonLinearityAPI >.

Public Member Functions

 NonLinearity (NonLinearityAPI *instance)
 
virtual ~NonLinearity ()
 
array< double > getCoeffs (long deviceID, int% errorCode)
 
array< double > getCoeffs (long deviceID, int% errorCode, int length)
 
- Public Member Functions inherited from NetOceanDirect::ManagedObject< NonLinearityAPI >
 ManagedObject (NonLinearityAPI *instance)
 
 !ManagedObject ()
 
virtual ~ManagedObject ()
 
NonLinearityAPI * GetInstance ()
 

Static Public Member Functions

static NonLinearity getInstance ()
 

Protected Member Functions

 NonLinearity ()
 

Static Protected Attributes

static NonLinearity linear
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ NonLinearity() [1/2]

NonLinearity::NonLinearity ( )
protected

◆ NonLinearity() [2/2]

NonLinearity::NonLinearity ( NonLinearityAPI * instance)

◆ ~NonLinearity()

virtual NetOceanDirect::NonLinearity::~NonLinearity ( )
inlinevirtual

Member Function Documentation

◆ getCoeffs() [1/2]

array< double > NonLinearity::getCoeffs ( long deviceID,
int% errorCode )

Retrieve all the nonlinearity correction coefficients from the given device.

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
Returns
tracked handle to a new array of length length containing the device's nonlinearity correction coefficients

◆ getCoeffs() [2/2]

array< double > NonLinearity::getCoeffs ( long deviceID,
int% errorCode,
int length )

Retrieve the nonlinearity correction coefficients from the given device.

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
[in]lengththe number of coefficients to read
Returns
tracked handle to a new array of length length containing the device's nonlinearity correction coefficients

◆ getInstance()

NonLinearity NonLinearity::getInstance ( )
static

Member Data Documentation

◆ linear

NonLinearity NetOceanDirect::NonLinearity::linear
staticprotected

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