Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Task Class Reference
This is an abstract task class with a method that is called periodically by a task sequencer. More...
#include <Task.h>
Inherited by TaskMove, TaskMoveTo, TaskMoveToWaypoint, and TaskWait.
Public Member Functions | |
| Task () | |
| Creates an abstract task object. | |
| virtual | ~Task () |
| Deletes the task object. | |
| virtual int | run (float period) |
| This method is called periodically by a task sequencer. | |
Static Public Attributes | |
| static const int | FAULT = -1 |
| Task return value. | |
| static const int | RUNNING = 0 |
| Task return value. | |
| static const int | DONE = 1 |
| Task return value. | |
Detailed Description
This is an abstract task class with a method that is called periodically by a task sequencer.
Definition at line 16 of file Task.h.
Constructor & Destructor Documentation
Member Function Documentation
| int run | ( | float | period ) | [virtual] |
This method is called periodically by a task sequencer.
It contains the code this task has to work on.
- Parameters:
-
period the period of the task sequencer, given in [s].
- Returns:
- the status of this task, i.e. RUNNING or DONE.
Reimplemented in TaskMove, TaskMoveTo, TaskMoveToWaypoint, and TaskWait.
Field Documentation
Generated on Wed Jul 27 2022 09:04:32 by
1.7.2