fsfw/thermal/AbstractTemperatureSensor.h
Robin Mueller e15839b3a6 Thermal: Some formatting stuff, doc to do
Need to find out how to use the thermal components
2020-02-15 18:26:25 +01:00

65 lines
1.8 KiB
C++

#ifndef ABSTRACTSENSOR_H_
#define ABSTRACTSENSOR_H_
#include <framework/health/HasHealthIF.h>
#include <framework/health/HealthHelper.h>
#include <framework/objectmanager/SystemObject.h>
#include <framework/tasks/ExecutableObjectIF.h>
#include <framework/parameters/ParameterHelper.h>
#include <framework/ipc/MessageQueueIF.h>
#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.
* Please use the TemperatureSensor class to implement the actual sensors.
* @ingroup thermal
*/
class AbstractTemperatureSensor: public HasHealthIF,
public SystemObject,
public ExecutableObjectIF,
public ReceivesParameterMessagesIF {
public:
static const uint8_t SUBSYSTEM_ID = SUBSYSTEM_ID::T_SENSORS;
static const Event TEMP_SENSOR_HIGH = MAKE_EVENT(0, SEVERITY::LOW);
static const Event TEMP_SENSOR_LOW = MAKE_EVENT(1, SEVERITY::LOW);
static const Event TEMP_SENSOR_GRADIENT = MAKE_EVENT(2, SEVERITY::LOW);
static constexpr float ZERO_KELVIN_C = -273.15;
AbstractTemperatureSensor(object_id_t setObjectid,
ThermalModuleIF *thermalModule);
virtual ~AbstractTemperatureSensor();
virtual MessageQueueId_t getCommandQueue() const;
ReturnValue_t initialize();
ReturnValue_t performHealthOp();
ReturnValue_t performOperation(uint8_t opCode);
virtual float getTemperature() = 0;
virtual bool isValid() = 0;
virtual void resetOldState() = 0;
ReturnValue_t setHealth(HealthState health);
HasHealthIF::HealthState getHealth();
protected:
MessageQueueIF* commandQueue;
HealthHelper healthHelper;
ParameterHelper parameterHelper;
virtual void doChildOperation() = 0;
void handleCommandQueue();
};
#endif /* ABSTRACTSENSOR_H_ */