Merge pull request 'new intialize after task creation function' (#137) from KSat/fsfw:mueller_ExecutableObjectIF_newInit into master
This commit is contained in:
commit
7a4a2f986a
@ -1,15 +1,5 @@
|
|||||||
/**
|
#ifndef FRAMEWORK_TASKS_EXECUTABLEOBJECTIF_H_
|
||||||
* @file ExecutableObjectIF.h
|
#define FRAMEWORK_TASKS_EXECUTABLEOBJECTIF_H_
|
||||||
*
|
|
||||||
* @brief This file contains the definition for the ExecutableObjectIF interface.
|
|
||||||
*
|
|
||||||
* @author Bastian Baetz
|
|
||||||
*
|
|
||||||
* @date 12.03.2012
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef EXECUTABLEOBJECTIF_H_
|
|
||||||
#define EXECUTABLEOBJECTIF_H_
|
|
||||||
|
|
||||||
class PeriodicTaskIF;
|
class PeriodicTaskIF;
|
||||||
|
|
||||||
@ -20,6 +10,7 @@ class PeriodicTaskIF;
|
|||||||
* @brief The interface provides a method to execute objects within a task.
|
* @brief The interface provides a method to execute objects within a task.
|
||||||
* @details The performOperation method, that is required by the interface is
|
* @details The performOperation method, that is required by the interface is
|
||||||
* executed cyclically within a task context.
|
* executed cyclically within a task context.
|
||||||
|
* @author Bastian Baetz
|
||||||
*/
|
*/
|
||||||
class ExecutableObjectIF {
|
class ExecutableObjectIF {
|
||||||
public:
|
public:
|
||||||
@ -37,13 +28,26 @@ public:
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Function called during setup assignment of object to task
|
* @brief Function called during setup assignment of object to task
|
||||||
* @details Has to be called from the function that assigns the object to a task and
|
* @details
|
||||||
* enables the object implementation to overwrite this function and get a reference to the executing task
|
* Has to be called from the function that assigns the object to a task and
|
||||||
|
* enables the object implementation to overwrite this function and get
|
||||||
|
* a reference to the executing task
|
||||||
* @param task_ Pointer to the taskIF of this task
|
* @param task_ Pointer to the taskIF of this task
|
||||||
*/
|
*/
|
||||||
virtual void setTaskIF(PeriodicTaskIF* task_) {
|
virtual void setTaskIF(PeriodicTaskIF* task_) {};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This function should be called after the object was assigned to a
|
||||||
|
* specific task.
|
||||||
|
*
|
||||||
|
* Example: Can be used to get task execution frequency.
|
||||||
|
* The task is created after initialize() and the object ctors have been
|
||||||
|
* called so the execution frequency can't be cached in initialize()
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
virtual ReturnValue_t initializeAfterTaskCreation() {
|
||||||
|
return HasReturnvaluesIF::RETURN_OK;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
#endif /* EXECUTABLEOBJECTIF_H_ */
|
#endif /* FRAMEWORK_TASKS_EXECUTABLEOBJECTIF_H_ */
|
||||||
|
Loading…
Reference in New Issue
Block a user