NetOceanDirect  2.4.0
OceanDirect .NET API
Public Member Functions | Static Public Member Functions | List of all members
NetOceanDirect::ThermoElectric Class Reference

Inherits NetOceanDirect::ManagedObject< ThermoElectricAPI >.

Public Member Functions

bool getEnable (long deviceID, int% errorCode)
 
bool getFanEnable (long deviceID, int% errorCode)
 
bool getStable (long deviceID, int% errorCode)
 
double getTemperatureDegreesC (long deviceID, int% errorCode)
 
float getTemperatureSetpointDegreesC (long deviceID, int% errorCode)
 
void setEnable (long deviceID, int% errorCode, bool tecEnable)
 
void setTemperatureSetpointDegreesC (long deviceID, int% errorCode, double temperatureDegreesCelsius)
 
- Public Member Functions inherited from NetOceanDirect::ManagedObject< ThermoElectricAPI >
 ManagedObject (ThermoElectricAPI *instance)
 
ThermoElectricAPI * GetInstance ()
 

Static Public Member Functions

static ThermoElectric getInstance ()
 

Additional Inherited Members

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

Member Function Documentation

◆ getEnable()

bool ThermoElectric::getEnable ( long  deviceID,
int%  errorCode 
)

Returns true if the Thermo-Electric Cooler (TEC) on a given device has been enabled.

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
true if the TEC is enabled otherwise it would be false.

◆ getFanEnable()

bool ThermoElectric::getFanEnable ( long  deviceID,
int%  errorCode 
)

Returns true if the Thermo-Electric Cooler (TEC) fan on a given device has been enabled.

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
true if the TEC fan is enabled otherwise it would be false.

◆ getStable()

bool ThermoElectric::getStable ( long  deviceID,
int%  errorCode 
)

Returns true if the Thermo-Electric Cooler (TEC) on a given device has reached the the setpoint temperature and is not changing.

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
true if the TEC temperature is stable otherwise it would be false.

◆ getTemperatureDegreesC()

double ThermoElectric::getTemperatureDegreesC ( long  deviceID,
int%  errorCode 
)

Reads the current temperature of the Thermo-Electric Cooler (TEC) on a given device (not the setpoint).

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
the TEC's current temperature, in degrees Celsius

◆ getTemperatureSetpointDegreesC()

float ThermoElectric::getTemperatureSetpointDegreesC ( long  deviceID,
int%  errorCode 
)

Reads the setpoint temperature of the Thermo-Electric Cooler (TEC) on a 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
the TEC's setpoint temperature, in degrees Celsius

◆ setEnable()

void ThermoElectric::setEnable ( long  deviceID,
int%  errorCode,
bool  tecEnable 
)

Enables/disables the Thermo-Electric Cooler (TEC) on 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
[in]tecEnablenew TEC enable state - if false, TEC will be disabled - otherwise, TEC will be enabled

◆ setTemperatureSetpointDegreesC()

void ThermoElectric::setTemperatureSetpointDegreesC ( long  deviceID,
int%  errorCode,
double  temperatureDegreesCelsius 
)

Sets the Thermo-Electric Cooler (TEC) setpoint on the given device, which is the target temperature it will try to reach

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
[in]temperatureDegreesCelsiusthe new setpoint, in degrees Celsius

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