basic documentation thermal
This commit is contained in:
parent
9ec0b80497
commit
9aa57f29b8
@ -10,6 +10,15 @@
|
||||
#include "ThermalModuleIF.h"
|
||||
#include "tcsDefinitions.h"
|
||||
|
||||
/**
|
||||
* @defgroup thermal Thermal Components
|
||||
* @brief Contains all components related to thermal tasks (sensors, heaters)
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Base class for Temperature Sensor, implements all important interfaces
|
||||
* @ingroup thermal
|
||||
*/
|
||||
class AbstractTemperatureSensor: public HasHealthIF,
|
||||
public SystemObject,
|
||||
public ExecutableObjectIF,
|
||||
|
@ -8,6 +8,7 @@
|
||||
#include <framework/thermal/ThermalModule.h>
|
||||
#include <framework/thermal/ThermalMonitor.h>
|
||||
|
||||
// TODO: Documentaiton, how to use this? only use Thermal COmponent, which inherits core component?
|
||||
class CoreComponent: public ThermalComponentIF {
|
||||
public:
|
||||
struct Parameters {
|
||||
|
@ -5,6 +5,14 @@
|
||||
#include "AbstractTemperatureSensor.h"
|
||||
#include <framework/monitoring/LimitMonitor.h>
|
||||
|
||||
/**
|
||||
* @brief This building block handles non-linear value conversion and
|
||||
* range checks for analog temperature sensors.
|
||||
* @details
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
template<typename T>
|
||||
class TemperatureSensor: public AbstractTemperatureSensor {
|
||||
public:
|
||||
|
@ -11,6 +11,9 @@
|
||||
#include "RedundantHeater.h"
|
||||
class PowerSwitchIF;
|
||||
|
||||
/**
|
||||
* @brief Allows creation of different thermal control domains within a system.
|
||||
*/
|
||||
class ThermalModule: public ThermalModuleIF {
|
||||
friend class ThermalController;
|
||||
public:
|
||||
|
Loading…
Reference in New Issue
Block a user