A step queue in the preview window. More...

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

Inheritance diagram for dynamicgraph::sot::StepQueue:

Collaboration diagram for dynamicgraph::sot::StepQueue:

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

	StepQueue (const std::string &name)

void	startSequence ()

void	pushStep (double x, double y, double theta)

const FootPrint &	getStep (unsigned int index) const

const FootPrint &	getFirstStep () const

const FootPrint &	getLastStep () const

void	changeFirstStep (double x, double y, double dtheta)
	Changes the first step. More...

const FootPrint &	getFirstStepChange () const

bool	isFirstStepChanged () const

unsigned int	size () const
	Access to the step queue properties (constants). More...

const FootPrint &	getStartFootPrint () const

double	getZeroStepPosition () const

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

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

Static Public Attributes
static const std::string	CLASS_NAME

Detailed Description

A step queue in the preview window.

A series of step in the preview window. The first step can be modified.

Invariant: {The queue always contains 4 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

◆ StepQueue()

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

Builds a queue containing a starting step and three steps in the preview. The steps correspond to on-place stepping: (0, +/- y, 0), where y == StepQueue::ZERO_STEP_POSITION

Member Function Documentation

◆ changeFirstStep()

void dynamicgraph::sot::StepQueue::changeFirstStep	(	double	x,
		double	y,
		double	dtheta
	)

Changes the first step.

◆ commandLine()

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

virtual

◆ display()

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

virtual

◆ getClassName()

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

inlinevirtual

◆ getFirstStep()

const FootPrint& dynamicgraph::sot::StepQueue::getFirstStep ( ) const

◆ getFirstStepChange()

const FootPrint& dynamicgraph::sot::StepQueue::getFirstStepChange ( ) const

◆ getLastStep()

const FootPrint& dynamicgraph::sot::StepQueue::getLastStep ( ) const

◆ getStartFootPrint()

const FootPrint& dynamicgraph::sot::StepQueue::getStartFootPrint ( ) const

◆ getStep()

const FootPrint& dynamicgraph::sot::StepQueue::getStep ( unsigned int index ) const

Access to the step queue.

Warning: {No check is performed on the indices used in these accessors.}

◆ getZeroStepPosition()

double dynamicgraph::sot::StepQueue::getZeroStepPosition ( ) const

◆ isFirstStepChanged()

bool dynamicgraph::sot::StepQueue::isFirstStepChanged ( ) const

Returns true if the first step has been changed since the last call to pushStep.

◆ pushStep()

void dynamicgraph::sot::StepQueue::pushStep	(	double	x,
		double	y,
		double	theta
	)

Adds a step at the end of the preview window. The step at the beginning of the preview window is removed. The firstStepChanged flag is reset to false.

◆ size()

unsigned int dynamicgraph::sot::StepQueue::size ( ) const

Access to the step queue properties (constants).

◆ startSequence()

void dynamicgraph::sot::StepQueue::startSequence ( )

Resets the queue to the initial condition (see the constructor, StepQueue::StepQueue).

Member Data Documentation

◆ CLASS_NAME

const std::string dynamicgraph::sot::StepQueue::CLASS_NAME

static

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

include/sot/pattern-generator/step-queue.h

Public Member Functions

Static Public Attributes