taskmon::Task Class Reference

#include <Task.hpp>

Inheritance diagram for taskmon::Task:

Classes
struct	Watch

Public Member Functions
	Task (std::string const &name="taskmon::Task", TaskCore::TaskState initial_state=Stopped)
bool	startHook ()
	The following lines are template definitions for the various state machine. More...
void	updateHook ()
void	stopHook ()

Protected Types
typedef std::map< boost::int32_t, Watch >	TaskWatches

Protected Member Functions
virtual void	watch (std::string const &name, boost::int32_t pid)
virtual void	removeWatchFromName (std::string const &name)
virtual void	removeWatchFromPID (boost::int32_t pid)
void	processProcInfo (bool watch_all, TaskStats &stats, proc_t const &proc_info)

Protected Attributes
TaskWatches	watches
PROCTAB *	proctab
double	sysClockPeriodInMuS

Friends
class	TaskBase

Member Typedef Documentation

TaskWatches

typedef std::map<boost::int32_t, Watch> taskmon::Task::TaskWatches

protected

Constructor & Destructor Documentation

Task()

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

Member Function Documentation

processProcInfo()

void Task::processProcInfo ( bool  watch_all, TaskStats &  stats, proc_t const &  proc_info  )

protected

removeWatchFromName()

void Task::removeWatchFromName ( std::string const &  name )

protectedvirtual

removeWatchFromPID()

void Task::removeWatchFromPID ( boost::int32_t  pid )

protectedvirtual

startHook()

bool Task::startHook

(

)

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

stopHook()

void Task::stopHook

(

)

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 recovered() to go back in the Runtime state. This hook is called by Orocos when the state machine transitions from Running to Stopped after stop() has been called.

updateHook()

void Task::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.

watch()

void Task::watch ( std::string const &  name, boost::int32_t  pid  )

protectedvirtual

Friends And Related Function Documentation

TaskBase

friend class TaskBase

friend

Member Data Documentation

proctab

PROCTAB* taskmon::Task::proctab

protected

sysClockPeriodInMuS

double taskmon::Task::sysClockPeriodInMuS

protected

watches

TaskWatches taskmon::Task::watches

protected

---

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

• /build/rock-master-18.09-drivers-orogen-taskmon-0.20160621/tasks/Task.hpp
• /build/rock-master-18.09-drivers-orogen-taskmon-0.20160621/tasks/Task.cpp