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.
TaskWait Class Reference
This is a specific implementation of a task class that waits for a given duration. More...
#include <TaskWait.h>
Inherits Task.
Public Member Functions | |
| TaskWait (Controller &controller, float duration) | |
| Creates a task object that waits for a given duration. | |
| virtual | ~TaskWait () |
| 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 a specific implementation of a task class that waits for a given duration.
Definition at line 17 of file TaskWait.h.
Constructor & Destructor Documentation
| TaskWait | ( | Controller & | controller, |
| float | duration | ||
| ) |
Creates a task object that waits for a given duration.
Definition at line 14 of file TaskWait.cpp.
| ~TaskWait | ( | ) | [virtual] |
Deletes the task object.
Definition at line 24 of file TaskWait.cpp.
Member Function Documentation
| int run | ( | float | period ) | [virtual] |
This method is called periodically by a task sequencer.
- Parameters:
-
period the period of the task sequencer, given in [s].
- Returns:
- the status of this task, i.e. RUNNING or DONE.
Reimplemented from Task.
Definition at line 31 of file TaskWait.cpp.
Field Documentation
Generated on Wed Jul 27 2022 09:04:32 by
1.7.2