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

#include <AutoNulling.h>

Inherits NetOceanDirect::ManagedObject< AutoNullingAPI >.

Public Member Functions

 AutoNulling (AutoNullingAPI *instance)
 
virtual ~AutoNulling ()
 
int getBaselineLevel (long deviceID, int% errorCode)
 
void getBaselineLevelConstraints (long deviceID, int% errorCode, std::uint32_t% minDAC, std::uint32_t% maxDAC, float% minVolts, float% maxVolts)
 
int getFPGADigitalGain (long deviceID, int% errorCode)
 
int getFPGADigitalOffset (long deviceID, int% errorCode)
 
int getMaximumADCCount (long deviceID, int% errorCode)
 
int getSaturationLevel (long deviceID, int% errorCode)
 
void getSaturationLevelConstraints (long deviceID, int% errorCode, std::uint32_t% minDAC, std::uint32_t% maxDAC, float% minVolts, float% maxVolts)
 
- Public Member Functions inherited from NetOceanDirect::ManagedObject< AutoNullingAPI >
 ManagedObject (AutoNullingAPI *instance)
 
 !ManagedObject ()
 
virtual ~ManagedObject ()
 
AutoNullingAPI * GetInstance ()
 

Static Public Member Functions

static AutoNulling getInstance ()
 

Protected Member Functions

 AutoNulling ()
 

Static Protected Attributes

static AutoNulling autonulling
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ AutoNulling() [1/2]

AutoNulling::AutoNulling ( )
protected

◆ AutoNulling() [2/2]

AutoNulling::AutoNulling ( AutoNullingAPI * instance)

◆ ~AutoNulling()

virtual NetOceanDirect::AutoNulling::~AutoNulling ( )
inlinevirtual

Member Function Documentation

◆ getBaselineLevel()

int AutoNulling::getBaselineLevel ( long deviceID,
int% errorCode )

◆ getBaselineLevelConstraints()

void AutoNulling::getBaselineLevelConstraints ( long deviceID,
int% errorCode,
std::uint32_t% minDAC,
std::uint32_t% maxDAC,
float% minVolts,
float% maxVolts )

Read autonulling constraints value for baseline settings. This command only applies to Ocean FX/HDX units.

Parameters
[in]deviceIdthe device ID for the device to be configured.
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;
[out]minDACminimum offset DAC value.
[out]maxDACmaximum offset DAC value.
[out]minVoltsminimum offset volt value.
[out]maxVoltsmaximum offset volt value.

◆ getFPGADigitalGain()

int AutoNulling::getFPGADigitalGain ( long deviceID,
int% errorCode )

◆ getFPGADigitalOffset()

int AutoNulling::getFPGADigitalOffset ( long deviceID,
int% errorCode )

◆ getInstance()

AutoNulling AutoNulling::getInstance ( )
static

◆ getMaximumADCCount()

int AutoNulling::getMaximumADCCount ( long deviceID,
int% errorCode )

Enables/disables the specified strobe lamp connected to the given device.

Parameters
[in]deviceIDthe device ID for the device to be configured (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]enableif true, lamp is to be enabled - will be disabled otherwise
See also
isEnabled()

◆ getSaturationLevel()

int AutoNulling::getSaturationLevel ( long deviceID,
int% errorCode )

◆ getSaturationLevelConstraints()

void AutoNulling::getSaturationLevelConstraints ( long deviceID,
int% errorCode,
std::uint32_t% minDAC,
std::uint32_t% maxDAC,
float% minVolts,
float% maxVolts )

Read autonulling constraints value for saturation settings. This command only applies to Ocean FX/HDX units.

Parameters
[in]deviceIdthe device ID for the device to be configured.
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;
[out]minDACminimum saturation DAC value.
[out]maxDACmaximum saturation DAC value.
[out]minVoltsminimum saturation volt value.
[out]maxVoltsmaximum saturation volt value.

Member Data Documentation

◆ autonulling

AutoNulling NetOceanDirect::AutoNulling::autonulling
staticprotected

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