fsfw/tasks/FixedTimeslotTaskIF.h

36 lines
1018 B
C
Raw Normal View History

2020-08-28 18:33:29 +02:00
#ifndef FRAMEWORK_TASKS_FIXEDTIMESLOTTASKIF_H_
#define FRAMEWORK_TASKS_FIXEDTIMESLOTTASKIF_H_
2020-12-14 11:49:01 +01:00
#include "PeriodicTaskIF.h"
2020-08-28 18:33:29 +02:00
#include "../objectmanager/ObjectManagerIF.h"
/**
* @brief Following the same principle as the base class IF.
2020-12-14 11:49:01 +01:00
* This is the interface for a Fixed timeslot task
2020-08-28 18:33:29 +02:00
*/
class FixedTimeslotTaskIF : public PeriodicTaskIF {
public:
virtual ~FixedTimeslotTaskIF() {}
/**
* Add an object with a slot time and the execution step to the task.
2020-12-22 16:24:52 +01:00
* The execution step will be passed to the object (e.g. as an operation
* code in #performOperation)
2020-08-28 18:33:29 +02:00
* @param componentId
* @param slotTimeMs
* @param executionStep
* @return
*/
2020-12-14 11:49:01 +01:00
virtual ReturnValue_t addSlot(object_id_t componentId, uint32_t slotTimeMs,
int8_t executionStep) = 0;
2020-08-28 18:33:29 +02:00
/**
* Check whether the sequence is valid and perform all other required
* initialization steps which are needed after task creation
*/
virtual ReturnValue_t checkSequence() const = 0;
};
2020-12-14 11:49:01 +01:00
2020-08-28 18:33:29 +02:00
#endif /* FRAMEWORK_TASKS_FIXEDTIMESLOTTASKIF_H_ */