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

Inheritance diagram for dynamicgraph::sot::StepTimeLine:

Collaboration diagram for dynamicgraph::sot::StepTimeLine:

Public Member Functions
virtual const std::string &	getClassName (void) const

	StepTimeLine (const std::string &name)

int &	triggerCall (int &dummy, int timeCurr)

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

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

Public Attributes
Signal< int, int >	triggerSOUT

Static Public Attributes
static const std::string	CLASS_NAME

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

◆ StepTimeLine()

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

Member Function Documentation

◆ commandLine()

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

virtual

◆ display()

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

virtual

◆ getClassName()

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

inlinevirtual

◆ triggerCall()

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

◆ CLASS_NAME

const std::string dynamicgraph::sot::StepTimeLine::CLASS_NAME

static

◆ triggerSOUT

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.

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

include/sot/pattern-generator/step-time-line.h

Public Member Functions

Public Attributes

Static Public Attributes