eive/fsfw
eive/fsfw
14
1
Fork 0
forked from fsfw/fsfw
Code Issues Pull Requests Releases 1 Wiki Activity

improved include guard and removed old comment

Browse Source
This commit is contained in:
Robin Müller 2020-06-02 15:57:04 +02:00
parent 42f0687a6b
commit de6ed5c085
1 changed files with 15 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
osal/FreeRTOS/PeriodicTask.h
View File

@ -1,5 +1,5 @@
#ifndef PERIODICTASK_H_ #ifndef FRAMEWORK_OSAL_FREERTOS_PERIODICTASK_H_
#define PERIODICTASK_H_ #define FRAMEWORK_OSAL_FREERTOS_PERIODICTASK_H_
#include <framework/objectmanager/ObjectManagerIF.h> #include <framework/objectmanager/ObjectManagerIF.h>
#include <framework/tasks/PeriodicTaskIF.h> #include <framework/tasks/PeriodicTaskIF.h>
@ -17,8 +17,6 @@ class ExecutableObjectIF;
/** /**
* @brief This class represents a specialized task for * @brief This class represents a specialized task for
* periodic activities of multiple objects. * periodic activities of multiple objects.
* @details
*
* @ingroup task_handling * @ingroup task_handling
*/ */
class PeriodicTask: public PeriodicTaskIF { class PeriodicTask: public PeriodicTaskIF {
@ -26,24 +24,25 @@ public:
/** /**
* @brief Standard constructor of the class. * @brief Standard constructor of the class.
* @details * @details
* The class is initialized without allocated objects. These need to be added * The class is initialized without allocated objects.
* with #addComponent. In the underlying TaskBase class, a new operating * These need to be added with #addComponent.
* system task is created. In addition to the TaskBase parameters, * @param priority
* the period, the pointer to the aforementioned initialization function and * Sets the priority of a task. Values depend on freeRTOS configuration,
* an optional "deadline-missed" function pointer is passed. * high number means high priority.
* @param priority Sets the priority of a task. Values depend on * @param stack_size
* freeRTOS configuration, high number means high priority. * The stack size reserved by the operating system for the task.
* @param stack_size The stack size reserved by the operating system for the task. * @param setPeriod
* @param setPeriod The length of the period with which the task's * The length of the period with which the task's
* functionality will be executed. It is expressed in clock ticks. * functionality will be executed. It is expressed in clock ticks.
* @param setDeadlineMissedFunc * @param setDeadlineMissedFunc
* The function pointer to the deadline missed function that shall be assigned. * The function pointer to the deadline missed function that shall
* be assigned.
*/ */
PeriodicTask(const char *name, TaskPriority setPriority, TaskStackSize setStack, PeriodicTask(const char *name, TaskPriority setPriority, TaskStackSize setStack,
TaskPeriod setPeriod,void (*setDeadlineMissedFunc)()); TaskPeriod setPeriod,void (*setDeadlineMissedFunc)());
/** /**
* @brief Currently, the executed object's lifetime is not coupled with the task object's * @brief Currently, the executed object's lifetime is not coupled with
* lifetime, so the destructor is empty. * the task object's lifetime, so the destructor is empty.
*/ */
virtual ~PeriodicTask(void); virtual ~PeriodicTask(void);