image_preprocessing::StereoTask Class Reference

#include <StereoTask.hpp>

Inheritance diagram for image_preprocessing::StereoTask:

Public Member Functions
	StereoTask (std::string const &name="image_preprocessing::StereoTask", TaskCore::TaskState initial_state=Stopped)
	~StereoTask ()
bool	startHook ()
void	updateHook ()

Protected Attributes
RTT::extras::ReadOnlyPointer< base::samples::frame::FramePair >	out_frame_pair

Friends
class	StereoTaskBase

Constructor & Destructor Documentation

StereoTask()

StereoTask::StereoTask	(	std::string const &	name = "image_preprocessing::StereoTask",
		TaskCore::TaskState	initial_state = Stopped
	)

~StereoTask()

StereoTask::~StereoTask

(

)

Member Function Documentation

startHook()

bool StereoTask::startHook

(

)

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 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.

updateHook()

void StereoTask::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

StereoTaskBase

friend class StereoTaskBase

friend

Member Data Documentation

out_frame_pair

RTT::extras::ReadOnlyPointer<base::samples::frame::FramePair> image_preprocessing::StereoTask::out_frame_pair

protected

---

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

• /build/rock-master-18.09-perception-orogen-image-preprocessing-0.20150821/tasks/StereoTask.hpp
• /build/rock-master-18.09-perception-orogen-image-preprocessing-0.20150821/tasks/StereoTask.cpp