#include <ExampleTask.h>
Public Member Functions | |
ExampleTask (ResourcePointers resources, int argc, const char *argv[]) | |
Constructor. | |
~ExampleTask () | |
Destructor. | |
TaskPlate | getPlate () const |
Gets task plate (mandatory). | |
Time | getMaxDuration () |
Gets maxDuration, maximum allowed duration for a single call to the run function. | |
Time | getMaxSamplPeriod () |
Gets maxSamplPeriod, maximum allowed time period between two calls of a run. | |
Time | getMinSamplPeriod () |
Gets minSamplPeriod, minimum allowed time period between two calls of a run. | |
TaskOutputs | run () |
Run function. | |
ExampleTask (ResourcePointers resources, int argc, const char *argv[]) | |
Constructor. | |
~ExampleTask () | |
Destructor. | |
TaskPlate | getPlate () const |
Gets task plate (mandatory). | |
Time | getMaxDuration () |
Gets maxDuration, maximum allowed duration for a single call to the run function. | |
Time | getMaxSamplPeriod () |
Gets maxSamplPeriod, maximum allowed time period between two calls of a run. | |
Time | getMinSamplPeriod () |
Gets minSamplPeriod, minimum allowed time period between two calls of a run. | |
TaskOutputs | run () |
Run function. |
MipTasks::ExampleTask::ExampleTask | ( | ResourcePointers | resources, | |
int | argc, | |||
const char * | argv[] | |||
) |
Constructor.
Then, you have look at the requested resources. The following lines asks for a mobile robot, and save a pointer to it is saved in the variables of the task. The MobileRob is a mandatory resource of this task, so if not provided from ResourceUtilities::macroResFromPlate, the programm gives an error and exit.
The following lines asks for a shared memory and save a pointer to it is saved in the variables of the task. The SharedMem is a mandatory resource of this task, so if not provided from ResourceUtilities::macroResFromPlate, the programm gives an error and exit. The shared memory is then initialized.
The following lines asks for a DraWin and save a pointer to it in the variables of the task. The DraWin is not a mandatory resource of this task, so if not provided from ResourceUtilities::macroResFromPlate, the programm only gives a warning.
Then, it is possible to allocate all the algorithms and the variables needed from the task. The algorithms can also accept the options provided to the task.
MipTasks::ExampleTask::~ExampleTask | ( | ) |
Destructor.
MipTasks::ExampleTask::ExampleTask | ( | ResourcePointers | resources, | |
int | argc, | |||
const char * | argv[] | |||
) |
Constructor.
MipTasks::ExampleTask::~ExampleTask | ( | ) |
Destructor.
TaskPlate MipTasks::ExampleTask::getPlate | ( | ) | const [inline, virtual] |
Gets task plate (mandatory).
Implements MipTasks::Task.
Time MipTasks::ExampleTask::getMaxDuration | ( | ) | [inline, virtual] |
Gets maxDuration, maximum allowed duration for a single call to the run function.
Implements MipTasks::Task.
Time MipTasks::ExampleTask::getMaxSamplPeriod | ( | ) | [inline, virtual] |
Gets maxSamplPeriod, maximum allowed time period between two calls of a run.
Implements MipTasks::Task.
Time MipTasks::ExampleTask::getMinSamplPeriod | ( | ) | [inline, virtual] |
Gets minSamplPeriod, minimum allowed time period between two calls of a run.
Implements MipTasks::Task.
TaskOutputs MipTasks::ExampleTask::run | ( | void | ) | [virtual] |
Run function.
Implements MipTasks::Task.
TaskPlate MipTasks::ExampleTask::getPlate | ( | ) | const [inline, virtual] |
Gets task plate (mandatory).
Implements MipTasks::Task.
Time MipTasks::ExampleTask::getMaxDuration | ( | ) | [inline, virtual] |
Gets maxDuration, maximum allowed duration for a single call to the run function.
Implements MipTasks::Task.
Time MipTasks::ExampleTask::getMaxSamplPeriod | ( | ) | [inline, virtual] |
Gets maxSamplPeriod, maximum allowed time period between two calls of a run.
Implements MipTasks::Task.
Time MipTasks::ExampleTask::getMinSamplPeriod | ( | ) | [inline, virtual] |
Gets minSamplPeriod, minimum allowed time period between two calls of a run.
Implements MipTasks::Task.
TaskOutputs MipTasks::ExampleTask::run | ( | ) | [virtual] |
Run function.
Implements MipTasks::Task.