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

corrected doc for task factory interface

Browse Source
This commit is contained in:
Robin Müller 2020-05-31 00:23:38 +02:00
parent 7a22d12d0f
commit c8a36a79de
2 changed files with 27 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
osal/FreeRTOS/FixedTimeslotTask.h
View File

@ -10,15 +10,18 @@
class FixedTimeslotTask: public FixedTimeslotTaskIF { class FixedTimeslotTask: public FixedTimeslotTaskIF {
public: public:
/** /**
* @brief The standard constructor of the class. * Keep in Mind that you need to call before this vTaskStartScheduler()!
* * A lot of task parameters are set in "FreeRTOSConfig.h".
* @details This is the general constructor of the class. In addition to the TaskBase parameters, * @param name Name of the task, lenght limited by configMAX_TASK_NAME_LEN
* the following variables are passed: * @param setPriority Number of priorities specified by
* * configMAX_PRIORITIES. High taskPriority_ number means high priority.
* @param (*setDeadlineMissedFunc)() The function pointer to the deadline missed function that shall be assigned. * @param setStack Stack size in words (not bytes!).
* * Lower limit specified by configMINIMAL_STACK_SIZE
* @param getPst The object id of the completely initialized polling sequence. * @param overallPeriod Period in seconds.
* @param setDeadlineMissedFunc Callback if a deadline was missed.
* @return Pointer to the newly created task.
*/ */
FixedTimeslotTask(const char *name, TaskPriority setPriority, FixedTimeslotTask(const char *name, TaskPriority setPriority,
TaskStackSize setStack, TaskPeriod overallPeriod, TaskStackSize setStack, TaskPeriod overallPeriod,

36
tasks/TaskFactory.h
View File

@ -19,16 +19,14 @@ public:
static TaskFactory* instance(); static TaskFactory* instance();
/** /**
* Keep in Mind that you need to call before this vTaskStartScheduler()! * Generic interface to create a periodic task
* A lot of task parameters are set in "FreeRTOSConfig.h". * @param name_ Name of the task
* @param name_ Name of the task, lenght limited by configMAX_TASK_NAME_LEN * @param taskPriority_ Priority of the task
* @param taskPriority_ Number of priorities specified by * @param stackSize_ Stack size if the task
* configMAX_PRIORITIES. High taskPriority_ number means high priority. * @param periodInSeconds_ Period in seconds
* @param stackSize_ Stack size in words (not bytes!). * @param deadLineMissedFunction_ This function is called if a deadline was
* Lower limit specified by configMINIMAL_STACK_SIZE * missed
* @param period_ Period in seconds. * @return Pointer to the created periodic task class
* @param deadLineMissedFunction_ Callback if a deadline was missed.
* @return Pointer to the newly created task.
*/ */
PeriodicTaskIF* createPeriodicTask(TaskName name_, PeriodicTaskIF* createPeriodicTask(TaskName name_,
TaskPriority taskPriority_, TaskStackSize stackSize_, TaskPriority taskPriority_, TaskStackSize stackSize_,
@ -36,16 +34,14 @@ public:
TaskDeadlineMissedFunction deadLineMissedFunction_); TaskDeadlineMissedFunction deadLineMissedFunction_);
/** /**
* Keep in Mind that you need to call before this vTaskStartScheduler()! * Generic interface to create a fixed timeslot task
* A lot of task parameters are set in "FreeRTOSConfig.h". * @param name_ Name of the task
* @param name_ Name of the task, lenght limited by configMAX_TASK_NAME_LEN * @param taskPriority_ Priority of the task
* @param taskPriority_ Number of priorities specified by * @param stackSize_ Stack size if the task
* configMAX_PRIORITIES. High taskPriority_ number means high priority. * @param periodInSeconds_ Period in seconds
* @param stackSize_ Stack size in words (not bytes!). * @param deadLineMissedFunction_ This function is called if a deadline was
* Lower limit specified by configMINIMAL_STACK_SIZE * missed
* @param period_ Period in seconds. * @return Pointer to the created periodic task class
* @param deadLineMissedFunction_ Callback if a deadline was missed.
* @return Pointer to the newly created task.
*/ */
FixedTimeslotTaskIF* createFixedTimeslotTask(TaskName name_, FixedTimeslotTaskIF* createFixedTimeslotTask(TaskName name_,
TaskPriority taskPriority_, TaskStackSize stackSize_, TaskPriority taskPriority_, TaskStackSize stackSize_,