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. This components triggeres the mars mars cycle if the update-hook is called, this is useful if an sequence between componentes is needed, like it is possible with the trigger_component. More...

#include <Trigger.hpp>

Inheritance diagram for mars::Trigger:

Public Member Functions
	Trigger (std::string const &name="mars::Trigger")

	Trigger (std::string const &name, RTT::ExecutionEngine *engine)

	~Trigger ()

bool	configureHook ()
	The following lines are template definitions for the various state machine. More...

bool	startHook ()

void	updateHook ()

void	errorHook ()

void	stopHook ()

void	cleanupHook ()

Protected Member Functions
void	receiveData (const mars::data_broker::DataInfo &info, const mars::data_broker::DataPackage &package, int id)

Protected Attributes
pthread_mutex_t	mutex

pthread_cond_t	mutex_cv

Friends
class	TriggerBase

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. This components triggeres the mars mars cycle if the update-hook is called, this is useful if an sequence between componentes is needed, like it is possible with the trigger_component.

The name of a TaskContext is primarily defined via:

deployment 'deployment_name'
    task('custom_task_name','mars::Trigger')
end

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

Constructor & Destructor Documentation

Trigger::Trigger ( std::string const & name = "mars::Trigger" )

TaskContext constructor for Trigger

Parameters

name	Name of the task. This name needs to be unique to make it identifiable via nameservices.
initial_state	The initial TaskState of the TaskContext. Default is Stopped state.

Trigger::Trigger	(	std::string const &	name,
		RTT::ExecutionEngine *	engine
	)

TaskContext constructor for Trigger

Parameters

name	Name of the task. This name needs to be unique to make it identifiable for nameservices.
engine	The 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.

Trigger::~Trigger ( )

Default deconstructor of Trigger

Member Function Documentation

void Trigger::cleanupHook ( )

This hook is called by Orocos when the state machine transitions from Stopped to PreOperational, requiring the call to configureHook() before calling start() again.

bool Trigger::configureHook ( )

The following lines are template definitions for the various state machine.

This hook is called by Orocos when the state machine transitions from PreOperational to Stopped. If it returns false, then the component will stay in PreOperational. Otherwise, it goes into Stopped.

It is meaningful only if the #needs_configuration has been specified in the task context definition with (for example):

task_context "TaskName" do
  needs_configuration
  ...
end

void Trigger::errorHook ( )

This hook is called by Orocos when the component is in the RunTimeError state, at each activity step. See the discussion in updateHook() about triggering options.

Call recover() to go back in the Runtime state.

void Trigger::receiveData	(	const mars::data_broker::DataInfo &	info,
		const mars::data_broker::DataPackage &	package,
		int	id
	)

protected

bool Trigger::startHook ( )

This hook is called by Orocos when the state machine transitions from Stopped to Running. If it returns false, then the component will stay in Stopped. Otherwise, it goes into Running and updateHook() will be called.

void Trigger::stopHook ( )

This hook is called by Orocos when the state machine transitions from Running to Stopped after stop() has been called.

void Trigger::updateHook ( )

This hook is called by Orocos when the component is in the Running state, at each activity step. Here, the activity gives the "ticks" when the hook should be called.

The error(), exception() and fatal() calls, when called in this hook, allow to get into the associated RunTimeError, Exception and FatalError states.

In the first case, updateHook() is still called, and recover() allows you to go back into the Running state. In the second case, the errorHook() will be called instead of updateHook(). In Exception, the component is stopped and recover() needs to be called before starting it again. Finally, FatalError cannot be recovered.

Friends And Related Function Documentation

friend class TriggerBase

friend

Member Data Documentation

pthread_mutex_t mars::Trigger::mutex

protected

pthread_cond_t mars::Trigger::mutex_cv

protected

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

/build/rock-master-18.09-simulation-orogen-mars-0.20180420/tasks/Trigger.hpp
/build/rock-master-18.09-simulation-orogen-mars-0.20180420/tasks/Trigger.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation