sot-core  4.11.8
Hierarchical task solver plug-in for dynamic-graph.
dynamicgraph::sot::PeriodicCallEntity Class Reference

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

Inheritance diagram for dynamicgraph::sot::PeriodicCallEntity:

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
 

Public Attributes

Signal< int, int > triger
 
Signal< int, int > trigerOnce
 

Static Public Attributes

static const std::string CLASS_NAME
 

Additional Inherited Members

- Protected Types inherited from dynamicgraph::sot::PeriodicCall
typedef std::map< std::string, SignalToCallSignalMapType
 
- Protected Member Functions inherited from dynamicgraph::sot::PeriodicCall
 PeriodicCall (void)
 
virtual ~PeriodicCall (void)
 
void addDownsampledSignal (const std::string &name, dynamicgraph::SignalBase< int > &sig, const unsigned int &downsamplingFactor)
 
void addDownsampledSignal (const std::string &sigpath, const unsigned int &downsamplingFactor)
 
void addSignal (const std::string &name, dynamicgraph::SignalBase< int > &sig)
 
void addSignal (const std::string &args)
 
void rmSignal (const std::string &name)
 
void runSignals (const int &t)
 
void run (const int &t)
 
void clear (void)
 
void display (std::ostream &os) const
 
- Protected Attributes inherited from dynamicgraph::sot::PeriodicCall
SignalMapType signalMap
 
int innerTime
 

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

◆ PeriodicCallEntity()

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

◆ ~PeriodicCallEntity()

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

Member Function Documentation

◆ display()

virtual void dynamicgraph::sot::PeriodicCallEntity::display ( std::ostream &  os) const
virtual

◆ getClassName()

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

◆ trigerCall()

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

◆ trigerOnceCall()

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

Member Data Documentation

◆ CLASS_NAME

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

◆ triger

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

◆ trigerOnce

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

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