transformer
Public Member Functions | Protected Member Functions | Friends | List of all members
transformer::Task Class Reference

The task context provides and requires services. It uses an ExecutionEngine to perform its functions. Essential interfaces are operations, data flow ports and properties. These interfaces have been defined using the oroGen specification. In order to modify the interfaces you should (re)use oroGen and rely on the associated workflow. More...

#include <Task.hpp>

Inheritance diagram for transformer::Task:

Public Member Functions

 Task (std::string const &name="transformer::Task", TaskCore::TaskState initial_state=Stopped)
 
 Task (std::string const &name, RTT::ExecutionEngine *engine, TaskCore::TaskState initial_state=Stopped)
 
 ~Task ()
 

Protected Member Functions

virtual void setConfiguration (::transformer::ConfigurationState const &configuration)
 

Friends

class TaskBase
 

Detailed Description

The task context provides and requires services. It uses an ExecutionEngine to perform its functions. Essential interfaces are operations, data flow ports and properties. These interfaces have been defined using the oroGen specification. In order to modify the interfaces you should (re)use oroGen and rely on the associated workflow.

The name of a TaskContext is primarily defined via:

deployment 'deployment_name'
    task('custom_task_name','transformer::Task')
end

It can be dynamically adapted when the deployment is called with a prefix argument.

Constructor & Destructor Documentation

◆ Task() [1/2]

Task::Task ( std::string const &  name = "transformer::Task",
TaskCore::TaskState  initial_state = Stopped 
)

TaskContext constructor for Task

Parameters
nameName of the task. This name needs to be unique to make it identifiable via nameservices.
initial_stateThe initial TaskState of the TaskContext. Default is Stopped state.

◆ Task() [2/2]

Task::Task ( std::string const &  name,
RTT::ExecutionEngine *  engine,
TaskCore::TaskState  initial_state = Stopped 
)

TaskContext constructor for Task

Parameters
nameName of the task. This name needs to be unique to make it identifiable for nameservices.
engineThe RTT Execution engine to be used for this task, which serialises the execution of all commands, programs, state machines and incoming events for a task.
initial_stateThe initial TaskState of the TaskContext. Default is Stopped state.

◆ ~Task()

Task::~Task ( )

Default deconstructor of Task

Member Function Documentation

◆ setConfiguration()

void Task::setConfiguration ( ::transformer::ConfigurationState const &  configuration)
protectedvirtual

Friends And Related Function Documentation

◆ TaskBase

friend class TaskBase
friend

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