TEC interface class. More...
#include <dlapi.h>
Public Member Functions | |
virtual bool | getEnabled () const =0 |
true if TEC has been enabled, false otherwise. More... | |
virtual float | getSetpoint () const =0 |
Returns the value of the cooler's setpoint in degrees Celsius. More... | |
virtual float | getCoolerPower () const =0 |
Returns the current cooler power in percent of max power draw. More... | |
virtual float | getSensorThermopileTemperature () const =0 |
Return the value of the sensor's thermopile in degrees Celsius. More... | |
virtual float | getHeatSinkThermopileTemperature () const =0 |
Return the value of the heatsink's thermopile in degrees Celsius. More... | |
virtual IPromisePtr | setState (bool enable, float setpoint)=0 |
Toggles the TEC's operation status, and updates the TEC's setpoint. More... | |
Detailed Description
TEC interface class.
An interface for Cooler peripherals in a camera. This includes, but is not limited to, thermoelectric coolers. ITEC members are updated via the ICamera::queryStatus() command, and thus have no associated query calls with them.
Member Function Documentation
◆ getCoolerPower()
|
pure virtual |
Returns the current cooler power in percent of max power draw.
- Returns
- float cooler power in percent of max power draw.
Returns a value between 0 - 100% representing the load on the TEC cooler, as a fraction of the max power draw. This value is updated via calls to ICamera::queryStatus().
◆ getEnabled()
|
pure virtual |
true if TEC has been enabled, false otherwise.
- Returns
- bool true if cooler is enabled, false otherwise.
Check to see whether the TEC is enabled/disabled (i.e. the cooler power is on/off). This a buffered value, updated via calls to ITEC::setState().
◆ getHeatSinkThermopileTemperature()
|
pure virtual |
Return the value of the heatsink's thermopile in degrees Celsius.
- Returns
- float value of the heatsink's thermopile in degrees Celsius.
- See also
- ICamera::queryStatus()
Obtain the sensor's current temperature in degrees Celsius. Updated via calls to ICamera::queryStatus().
◆ getSensorThermopileTemperature()
|
pure virtual |
Return the value of the sensor's thermopile in degrees Celsius.
- Returns
- float value of the sensor's thermopile in degrees Celsius.
- See also
- ICamera::queryStatus()
Obtain the sensor's current temperature in degrees Celsius. Updated via calls to ICamera::queryStatus().
◆ getSetpoint()
|
pure virtual |
Returns the value of the cooler's setpoint in degrees Celsius.
- Returns
- float value of the cooler's setpoint in degrees Celsius.
Obtain the cooler's current setpoint in degrees Celsius. This value is a buffered value, updated via calls to ITEC:setState().
◆ setState()
|
pure virtual |
Toggles the TEC's operation status, and updates the TEC's setpoint.
- Parameters
-
enable true to enable the TEC, false to disable it. setpoint the desired setpoint of the TEC in degrees Celsius.
- Returns
- IPromisePtr a promise pointer for the asynchronous operation.
- See also
- IPromisePtr
Check to see whether the TEC is enabled/disabled (i.e. the cooler power is on/off).
The documentation for this class was generated from the following file:
- C:/NightlyBuild/DL_Imaging/Aluma_Software/dlapi/src/dlapi.h