NetOceanDirectLighthouse 3.1.3
OceanDirect Lighthouse .NET API
NetLighthouse::NetLighthouseThermoelectric Class Reference

#include <NetLighthouseThermoelectric.h>

Inherits ManagedObject.

Public Member Functions

virtual ~NetLighthouseThermoelectric ()
 
virtual bool getTecStable (unsigned int deviceID, int %errorCode)
 
virtual lh_celcius_t getTecTemperature (unsigned int deviceID, int %errorCode)
 
virtual lh_celcius_t getTecTemperatureSetpoint (unsigned int deviceID, int% errorCode)
 
virtual void setTecTemperatureSetpoint (unsigned int deviceID, int% errorCode, lh_celcius_t celsius)
 

Static Public Member Functions

static NetLighthouseThermoelectric getInstance ()
 

Protected Member Functions

 NetLighthouseThermoelectric ()
 

Static Protected Attributes

static NetLighthouseThermoelectric thermo
 

Constructor & Destructor Documentation

◆ NetLighthouseThermoelectric()

NetLighthouseThermoelectric::NetLighthouseThermoelectric ( )
protected

◆ ~NetLighthouseThermoelectric()

virtual NetLighthouse::NetLighthouseThermoelectric::~NetLighthouseThermoelectric ( )
inlinevirtual

Member Function Documentation

◆ getInstance()

NetLighthouseThermoelectric NetLighthouseThermoelectric::getInstance ( )
static

◆ getTecStable()

bool NetLighthouseThermoelectric::getTecStable ( unsigned int deviceID,
int % errorCode )
virtual

.getTecStable Determine if the TEC temperature is stable (not changing).

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
true if the TEC temperature is stable, false otherwise or on error.

◆ getTecTemperature()

lh_celcius_t NetLighthouseThermoelectric::getTecTemperature ( unsigned int deviceID,
int % errorCode )
virtual

.getTecTemperature Get the current TEC temperature in Celcius.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the TEC temperature in Celcius, or 0.0 on error.

◆ getTecTemperatureSetpoint()

lh_celcius_t NetLighthouseThermoelectric::getTecTemperatureSetpoint ( unsigned int deviceID,
int% errorCode )
virtual

.getTecTemperatureSetpoint Get the current TEC temperature setpoint in Celcius.

See also
setTecTemperatureSetpoint()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the TEC temperature setpoint in Celcius, or 0.0 on error.

◆ setTecTemperatureSetpoint()

void NetLighthouseThermoelectric::setTecTemperatureSetpoint ( unsigned int deviceID,
int% errorCode,
lh_celcius_t celsius )
virtual

.setTecTemperatureSetpoint Set the desired TEC temperature setpoint in Celcius.

See also
getTecTemperatureSetpoint()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
celsiusthe desired TEC temperature in Celcius.

Member Data Documentation

◆ thermo

NetLighthouseThermoelectric NetLighthouse::NetLighthouseThermoelectric::thermo
staticprotected

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