dynamicgraph::sot::PeriodicCallEntity Class Reference

#include <sot/core/periodic-call-entity.hh>

Inheritance diagram for dynamicgraph::sot::PeriodicCallEntity:

List of all members.

Public Member Functions
virtual const std::string &	getClassName (void) const
int &	trigerCall (int &dummy, const int &time)
int &	trigerOnceCall (int &dummy, const int &time)
	PeriodicCallEntity (const std::string &name)
virtual	~PeriodicCallEntity (void)
virtual void	display (std::ostream &os) const
void	commandLine (const std::string &cmdLine, std::istringstream &cmdArgs, std::ostream &os)
Public Attributes
Signal< int, int >	triger
Signal< int, int >	trigerOnce
Static Public Attributes
static const std::string	CLASS_NAME

---

Detailed Description

The entity remembers a stack of signal and command to be executed or refreshed at each iteration. The update is trigered by the triger signal. If the trigerOnce is called, the stacks are flushed after the execution.

---

Constructor & Destructor Documentation

dynamicgraph::sot::PeriodicCallEntity::PeriodicCallEntity

(

const std::string &

name

)

virtual dynamicgraph::sot::PeriodicCallEntity::~PeriodicCallEntity

(

void

)

[inline, virtual]

---

Member Function Documentation

void dynamicgraph::sot::PeriodicCallEntity::commandLine	(	const std::string &	cmdLine,
		std::istringstream &	cmdArgs,
		std::ostream &	os
	)		[virtual]

Reimplemented from dynamicgraph::Entity.

virtual void dynamicgraph::sot::PeriodicCallEntity::display

(

std::ostream &

os

)

const [virtual]

Reimplemented from dynamicgraph::Entity.

virtual const std::string& dynamicgraph::sot::PeriodicCallEntity::getClassName

(

void

)

const [inline, virtual]

Implements dynamicgraph::Entity.

int& dynamicgraph::sot::PeriodicCallEntity::trigerCall	(	int &	dummy,
		const int &	time
	)

int& dynamicgraph::sot::PeriodicCallEntity::trigerOnceCall	(	int &	dummy,
		const int &	time
	)

---

Member Data Documentation

const std::string dynamicgraph::sot::PeriodicCallEntity::CLASS_NAME [static]

Signal<int,int> dynamicgraph::sot::PeriodicCallEntity::triger

Signal<int,int> dynamicgraph::sot::PeriodicCallEntity::trigerOnce