- Aldebaran documentation |
- C++ Libraries |
- index

libqicore-api 2.8.7.4

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- Class List
- Class Hierarchy
- Class Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Public Attributes | List of all members
qi::Task Class Referenceabstract

`#include <task.hpp>`

## Public Member Functions
| Task ()
virtual | ~Task ()
virtual bool | interrupt ()=0

## Public Attributes
Property< bool > | running
| RO, Indicates if the task is currently running. More...
Property< std::string > | error

## Detailed Description

Definition at line 15 of file task.hpp.

## Constructor & Destructor Documentation

qi::Task::Task | ( |  | ) |
| inline

Definition at line 18 of file task.hpp.

virtual qi::Task::~Task | ( |  | ) |
| inline virtual

Definition at line 19 of file task.hpp.

## Member Function Documentation

virtual bool qi::Task::interrupt | ( |  | ) |
| pure virtual

Ask the task to interrupt itself.

Returns
  true if the request was successful. Does not imply that the Task is effectively stopped, but that it will eventually stop.

Implemented in qi::TaskCall< Future< T > >, and qi::TaskCall< T >.

## Member Data Documentation

Property<std::string> qi::Task::error

RO, Indicates if the task encountered an error. Empty for no error. Should be set to "interrupted" If interrupt() was called successfuly and the normal Task output will not trigger.

Definition at line 35 of file task.hpp.

Property<bool> qi::Task::running

RO, Indicates if the task is currently running.

Definition at line 29 of file task.hpp.

The documentation for this class was generated from the following file:

- /home/opennao/work/release-2.8/sdk/libqicore/libqicore/qicore/task.hpp