ROME2 - TI / Mbed 2 deprecated ROME2 - Praktikum

Dependencies:   mbed

Embed: (wiki syntax)

« Back to documentation index

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 TaskMoveTo, 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

Task (  )

Creates an abstract task object.

Definition at line 14 of file Task.cpp.

~Task (  ) [virtual]

Deletes the task object.

Definition at line 19 of file Task.cpp.


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:
periodthe period of the task sequencer, given in [s].
Returns:
the status of this task, i.e. TASK_RUNNING or TASK_DONE.

Reimplemented in TaskMoveTo, and TaskWait.

Definition at line 27 of file Task.cpp.


Field Documentation

const int DONE = 1 [static]

Task return value.

Definition at line 22 of file Task.h.

const int FAULT = -1 [static]

Task return value.

Definition at line 20 of file Task.h.

const int RUNNING = 0 [static]

Task return value.

Definition at line 21 of file Task.h.