#include <periodic-call-entity.hh>

Inheritance diagram for dynamicgraph::sot::PeriodicCallEntity:

Public Member Functions
virtual void	display (std::ostream &os) const

virtual const std::string &	getClassName (void) const

	PeriodicCallEntity (const std::string &name)

size_type &	trigerCall (size_type &dummy, const sigtime_t &time)

size_type &	trigerOnceCall (size_type &dummy, const sigtime_t &time)

virtual	~PeriodicCallEntity (void)

Public Member Functions inherited from dynamicgraph::Entity
std::ostream &	displaySignalList (std::ostream &os) const

	Entity (const std::string &name)

const std::string &	getCommandList () const

virtual std::string	getDocString () const

LoggerVerbosity	getLoggerVerbosityLevel ()

LoggerVerbosity	getLoggerVerbosityLevel ()

const std::string &	getName () const

command::Command *	getNewStyleCommand (const std::string &cmdName)

CommandMap_t	getNewStyleCommandMap ()

SignalBase< sigtime_t > &	getSignal (const std::string &signalName)

const SignalBase< sigtime_t > &	getSignal (const std::string &signalName) const

SignalMap	getSignalMap () const

double	getStreamPrintPeriod ()

double	getStreamPrintPeriod ()

double	getTimeSample ()

double	getTimeSample ()

bool	hasSignal (const std::string &signame) const

Logger &	logger ()

Logger &	logger ()

const Logger &	logger () const

const Logger &	logger () const

void	sendMsg (const std::string &msg, MsgType t=MSG_TYPE_INFO, const std::string &lineId="")

void	sendMsg (const std::string &msg, MsgType t=MSG_TYPE_INFO, const std::string &lineId="")

void	setLoggerVerbosityLevel (LoggerVerbosity lv)

void	setLoggerVerbosityLevel (LoggerVerbosity lv)

bool	setStreamPrintPeriod (double t)

bool	setStreamPrintPeriod (double t)

bool	setTimeSample (double t)

bool	setTimeSample (double t)

virtual SignalBase< sigtime_t > *	test ()

virtual void	test2 (SignalBase< sigtime_t > *)

virtual std::ostream &	writeCompletionList (std::ostream &os) const

virtual std::ostream &	writeGraph (std::ostream &os) const

virtual	~Entity ()

Public Attributes
Signal< size_type, sigtime_t >	triger

Signal< size_type, sigtime_t >	trigerOnce

Static Public Attributes
static const std::string	CLASS_NAME

Additional Inherited Members
Public Types inherited from dynamicgraph::Entity
typedef std::map< const std::string, command::Command * >	CommandMap_t

typedef std::map< std::string, SignalBase< sigtime_t > * >	SignalMap

Protected Types inherited from dynamicgraph::sot::PeriodicCall
typedef std::map< std::string, SignalToCall >	SignalMapType

Protected Member Functions inherited from dynamicgraph::Entity
void	addCommand (const std::string &name, command::Command *command)

void	entityDeregistration ()

void	entityRegistration ()

void	signalDeregistration (const std::string &name)

void	signalRegistration (const SignalArray< sigtime_t > &signals)

Protected Member Functions inherited from dynamicgraph::sot::PeriodicCall
void	addDownsampledSignal (const std::string &name, dynamicgraph::SignalBase< sigtime_t > &sig, const std::size_t &downsamplingFactor)

void	addDownsampledSignal (const std::string &sigpath, const std::size_t &downsamplingFactor)

void	addSignal (const std::string &args)

void	addSignal (const std::string &name, dynamicgraph::SignalBase< sigtime_t > &sig)

void	clear (void)

void	display (std::ostream &os) const

	PeriodicCall (void)

void	rmSignal (const std::string &name)

void	run (const sigtime_t &t)

void	runSignals (const sigtime_t &t)

virtual	~PeriodicCall (void)

Protected Attributes inherited from dynamicgraph::Entity
CommandMap_t	commandMap

Logger	logger_

std::string	name

SignalMap	signalMap

Protected Attributes inherited from dynamicgraph::sot::PeriodicCall
sigtime_t	innerTime

SignalMapType	signalMap

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.

Definition at line 56 of file periodic-call-entity.hh.

Constructor & Destructor Documentation

◆ PeriodicCallEntity()

PeriodicCallEntity::PeriodicCallEntity ( const std::string & name )

Definition at line 31 of file periodic-call-entity.cpp.

◆ ~PeriodicCallEntity()

virtual dynamicgraph::sot::PeriodicCallEntity::~PeriodicCallEntity ( void )

inlinevirtual

Definition at line 73 of file periodic-call-entity.hh.

Member Function Documentation

◆ display()

void PeriodicCallEntity::display ( std::ostream & os ) const

virtual

Reimplemented from dynamicgraph::Entity.

Definition at line 60 of file periodic-call-entity.cpp.

◆ getClassName()

virtual const std::string& dynamicgraph::sot::PeriodicCallEntity::getClassName ( void ) const

inlinevirtual

Reimplemented from dynamicgraph::Entity.

Definition at line 61 of file periodic-call-entity.hh.

◆ trigerCall()

size_type & PeriodicCallEntity::trigerCall	(	size_type &	dummy,
		const sigtime_t &	time
	)

Definition at line 44 of file periodic-call-entity.cpp.

◆ trigerOnceCall()

size_type & PeriodicCallEntity::trigerOnceCall	(	size_type &	dummy,
		const sigtime_t &	time
	)

Definition at line 49 of file periodic-call-entity.cpp.

Member Data Documentation

◆ CLASS_NAME

const std::string dynamicgraph::sot::PeriodicCallEntity::CLASS_NAME

static

Definition at line 60 of file periodic-call-entity.hh.

◆ triger

Signal<size_type, sigtime_t> dynamicgraph::sot::PeriodicCallEntity::triger

Definition at line 63 of file periodic-call-entity.hh.

◆ trigerOnce

Signal<size_type, sigtime_t> dynamicgraph::sot::PeriodicCallEntity::trigerOnce

Definition at line 64 of file periodic-call-entity.hh.

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

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members