footstep_planner::State Class Reference

A class representing the robot's pose (i.e. position and orientation) in the (continuous) world view. More precisely a state points to the robot's supporting leg. More...

#include <State.h>

Public Member Functions
Leg	getLeg () const
double	getTheta () const
double	getX () const
double	getY () const
bool	operator!= (const State &s2) const
	Inequality operator for two states (negates the equality operator). More...
bool	operator== (const State &s2) const
	Compare two states on equality of x, y, theta, leg upon a certain degree of float precision. More...
void	setLeg (Leg leg)
void	setTheta (double theta)
void	setX (double x)
void	setY (double y)
	State ()
	State (double x, double y, double theta, Leg leg)
	~State ()

Private Attributes
Leg	ivLeg
	The robot's supporting leg. More...
double	ivTheta
	The robot's orientation. More...
double	ivX
	The robot's position in x direction. More...
double	ivY
	The robot's position in y direction. More...

Detailed Description

A class representing the robot's pose (i.e. position and orientation) in the (continuous) world view. More precisely a state points to the robot's supporting leg.

Definition at line 34 of file State.h.

Constructor & Destructor Documentation

footstep_planner::State::State

(

)

Definition at line 26 of file State.cpp.

footstep_planner::State::State	(	double	x,
		double	y,
		double	theta,
		Leg	leg
	)

Definition at line 31 of file State.cpp.

footstep_planner::State::~State

(

)

Definition at line 36 of file State.cpp.

Member Function Documentation

Leg footstep_planner::State::getLeg ( ) const

inline

Definition at line 49 of file State.h.

double footstep_planner::State::getTheta ( ) const

inline

Definition at line 48 of file State.h.

double footstep_planner::State::getX ( ) const

inline

Definition at line 46 of file State.h.

double footstep_planner::State::getY ( ) const

inline

Definition at line 47 of file State.h.

bool footstep_planner::State::operator!=

(

const State &

s2

)

const

Inequality operator for two states (negates the equality operator).

Definition at line 53 of file State.cpp.

bool footstep_planner::State::operator==

(

const State &

s2

)

const

Compare two states on equality of x, y, theta, leg upon a certain degree of float precision.

Definition at line 41 of file State.cpp.

void footstep_planner::State::setLeg ( Leg  leg )

inline

Definition at line 44 of file State.h.

void footstep_planner::State::setTheta ( double  theta )

inline

Definition at line 43 of file State.h.

void footstep_planner::State::setX ( double  x )

inline

Definition at line 41 of file State.h.

void footstep_planner::State::setY ( double  y )

inline

Definition at line 42 of file State.h.

Member Data Documentation

Leg footstep_planner::State::ivLeg

private

The robot's supporting leg.

Definition at line 71 of file State.h.

double footstep_planner::State::ivTheta

private

The robot's orientation.

Definition at line 69 of file State.h.

double footstep_planner::State::ivX

private

The robot's position in x direction.

Definition at line 65 of file State.h.

double footstep_planner::State::ivY

private

The robot's position in y direction.

Definition at line 67 of file State.h.

---

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

• State.h
• State.cpp