sot::StepQueue Class Reference

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

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

Collaboration diagram for sot::StepQueue:

[legend]

List of all members.

Public Member Functions
virtual const std::string &	getClassName (void) const
	StepQueue (const std::string &name)
	Builds a queue containing a starting step and three steps in the preview.
void	startSequence ()
	Resets the queue to the initial condition (see the constructor, StepQueue::StepQueue).
void	pushStep (double x, double y, double theta)
	Adds a step at the end of the preview window.
void	changeFirstStep (double x, double y, double dtheta)
	Changes the first step.
const FootPrint &	getFirstStepChange () const
bool	isFirstStepChanged () const
	Returns true if the first step has been changed since the last call to pushStep.
virtual void	display (std::ostream &os) const
virtual void	commandLine (const std::string &cmdLine, std::istringstream &cmdArgs, std::ostream &os)
const FootPrint &	getStep (unsigned int index) const
	Access to the step queue.
const FootPrint &	getFirstStep () const
const FootPrint &	getLastStep () const
unsigned int	size () const
	Access to the step queue properties (constants).
const FootPrint &	getStartFootPrint () const
double	getZeroStepPosition () const
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

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

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

Changes the first step.

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

virtual void sot::StepQueue::display

(

std::ostream &

os

)

const [virtual]

virtual const std::string& sot::StepQueue::getClassName

(

void

)

const [inline, virtual]

const FootPrint& sot::StepQueue::getFirstStep

(

)

const

const FootPrint& sot::StepQueue::getFirstStepChange

(

)

const

const FootPrint& sot::StepQueue::getLastStep

(

)

const

const FootPrint& sot::StepQueue::getStartFootPrint

(

)

const

const FootPrint& sot::StepQueue::getStep

(

unsigned int

index

)

const

Access to the step queue.

Warning:

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

double sot::StepQueue::getZeroStepPosition

(

)

const

bool sot::StepQueue::isFirstStepChanged

(

)

const

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

void 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.

unsigned int sot::StepQueue::size

(

)

const

Access to the step queue properties (constants).

void sot::StepQueue::startSequence

(

)

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

---

Member Data Documentation

const std::string sot::StepQueue::CLASS_NAME [static]