Public Member Functions | Public Attributes | Static Public Attributes | List of all members
dynamicgraph::sot::PeriodicCallEntity Class Reference

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

Inheritance diagram for dynamicgraph::sot::PeriodicCallEntity:
[legend]

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 Member Functions inherited from dynamicgraph::Entity
 Entity (const std::string &name)
 
virtual ~Entity ()
 
const std::string & getName () const
 
virtual std::string getDocString () const
 
bool hasSignal (const std::string &signame) const
 
SignalBase< int > & getSignal (const std::string &signalName)
 
const SignalBase< int > & getSignal (const std::string &signalName) const
 
std::ostream & displaySignalList (std::ostream &os) const
 
virtual std::ostream & writeGraph (std::ostream &os) const
 
virtual std::ostream & writeCompletionList (std::ostream &os) const
 
virtual SignalBase< int > * test ()
 
virtual void test2 (SignalBase< int > *)
 
const std::string & getCommandList () const
 
CommandMap_t getNewStyleCommandMap ()
 
command::Command * getNewStyleCommand (const std::string &cmdName)
 
SignalMap getSignalMap () const
 
void sendMsg (const std::string &msg, MsgType t=MSG_TYPE_INFO, const char *file="", int line=0)
 
void setLoggerVerbosityLevel (LoggerVerbosity lv)
 
LoggerVerbosity getLoggerVerbosityLevel ()
 

Public Attributes

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

Static Public Attributes

static const std::string CLASS_NAME
 

Additional Inherited Members

- Public Types inherited from dynamicgraph::Entity
typedef std::map< std::string, SignalBase< int > * > SignalMap
 
typedef std::map< const std::string, command::Command * > CommandMap_t
 
- 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 entityRegistration ()
 
void entityDeregistration ()
 
void signalRegistration (const SignalArray< int > &signals)
 
void signalDeregistration (const std::string &name)
 
- 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
 
void addSpecificCommands (dynamicgraph::Entity &ent, dynamicgraph::Entity::CommandMap_t &commap, const std::string &prefix="")
 
- Protected Attributes inherited from dynamicgraph::Entity
std::string name
 
SignalMap signalMap
 
CommandMap_t commandMap
 
Logger logger_
 
- 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

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

Member Function Documentation

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
inlinevirtual

Reimplemented from 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