All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
dynamicgraph::sot::StepTimeLine Class Reference

Synchronizes the components for the automatic step generation. More...

#include <sot-pattern-generator/step-time-line.h>

Inheritance diagram for dynamicgraph::sot::StepTimeLine:
[legend]
Collaboration diagram for dynamicgraph::sot::StepTimeLine:
[legend]

Public Member Functions

virtual const std::string & getClassName (void) const
 
 StepTimeLine (const std::string &name)
 
int & triggerCall (int &dummy, int timeCurr)
 The trigger callback function, which implements the synchronization of all the sub-components used to generate and send the steps. More...
 
virtual void display (std::ostream &os) const
 
virtual void commandLine (const std::string &cmdLine, std::istringstream &cmdArgs, std::ostream &os)
 
- 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::CommandgetNewStyleCommand (const std::string &cmdName)
 
SignalMap getSignalMap () const
 

Public Attributes

Signal< int, int > triggerSOUT
 Trigger signal, to be updated periodically to trigger a call to the synchronization method. More...
 

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 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 Attributes inherited from dynamicgraph::Entity
std::string name
 
SignalMap signalMap
 
CommandMap_t commandMap
 

Detailed Description

Synchronizes the components for the automatic step generation.

   This entity automatically generates steps to send to a PatternGenerator
   entity. The responsibility of this entity is to synchronize all the
   components that are used to generate and send the steps, by triggering
   them at the appropriate time.

   This entity accepts the following shell commands:
   - state: stepper.state will print the current state of the timeline,
            stepper.state start will start the stepping,
            stepper.state stop will stop the stepping.

   The possible states of the timeline are the following:
   - starting: playing an initial step sequence (warmup),
   - started: generating steps using the StepComputer,
   - stopping: playing a final step sequence (cleanup),
   - stopped: doing nothing (not sending steps).

   \note{This entity class can not be instantiated in a shell since it does not

register any factory. This behavior is intended.}

Constructor & Destructor Documentation

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

Member Function Documentation

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

Reimplemented from dynamicgraph::Entity.

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

Reimplemented from dynamicgraph::Entity.

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

Implements dynamicgraph::Entity.

int& dynamicgraph::sot::StepTimeLine::triggerCall ( int &  dummy,
int  timeCurr 
)

The trigger callback function, which implements the synchronization of all the sub-components used to generate and send the steps.

Member Data Documentation

const std::string dynamicgraph::sot::StepTimeLine::CLASS_NAME
static
Signal< int,int > dynamicgraph::sot::StepTimeLine::triggerSOUT

Trigger signal, to be updated periodically to trigger a call to the synchronization method.

Typically, this signal is added to the periodic calls of OpenHRP.