controldev::JoystickTask Class Reference

#include <JoystickTask.hpp>

Inheritance diagram for controldev::JoystickTask:

Public Member Functions
	JoystickTask (std::string const &name="controldev::JoystickTask")
	JoystickTask (std::string const &name, RTT::ExecutionEngine *engine)
	~JoystickTask ()
bool	configureHook ()
	This hook is called by Orocos when the state machine transitions from PreOperational to Stopped. More...
void	updateHook ()
	This hook is called by Orocos when the state machine transitions from Stopped to Running. More...

Protected Member Functions
virtual bool	updateRawCommand (RawCommand &rcmd)
virtual int	getFileDescriptor ()

Protected Attributes
Joystick *	joystick

Friends
class	JoystickTaskBase

Constructor & Destructor Documentation

JoystickTask::JoystickTask

(

std::string const &

name = "controldev::JoystickTask"

)

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

JoystickTask::~JoystickTask

(

)

Member Function Documentation

bool JoystickTask::configureHook

(

)

This hook is called by Orocos when the state machine transitions from PreOperational to Stopped.

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

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

int JoystickTask::getFileDescriptor ( )

protectedvirtual

void JoystickTask::updateHook

(

)

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

bool JoystickTask::updateRawCommand ( RawCommand &  rcmd )

protectedvirtual

Friends And Related Function Documentation

friend class JoystickTaskBase

friend

Member Data Documentation

Joystick* controldev::JoystickTask::joystick

protected

---

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

• /build/rock-master-18.09-drivers-orogen-controldev-0.20180522/tasks/JoystickTask.hpp
• /build/rock-master-18.09-drivers-orogen-controldev-0.20180522/tasks/JoystickTask.cpp