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>
List of all members.
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).
|
| bool | operator== (const State &s2) const |
| | Compare two states on equality of x, y, theta, leg upon a certain degree of float precision.
|
| void | setLeg (Leg leg) |
| void | setTheta (double theta) |
| void | setX (double x) |
| void | setY (double y) |
| | State (double x, double y, double theta, Leg leg) |
| | State () |
| | ~State () |
Private Attributes |
| Leg | ivLeg |
| | The robot's supporting leg.
|
| double | ivTheta |
| | The robot's orientation.
|
| double | ivX |
| | The robot's position in x direction.
|
| double | ivY |
| | The robot's position in y direction.
|
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 37 of file State.h.
Constructor & Destructor Documentation
| footstep_planner::State::State |
( |
|
) |
|
| footstep_planner::State::State |
( |
double |
x, |
|
|
double |
y, |
|
|
double |
theta, |
|
|
Leg |
leg | |
|
) |
| | |
| footstep_planner::State::~State |
( |
|
) |
|
Member Function Documentation
| Leg footstep_planner::State::getLeg |
( |
|
) |
const [inline] |
| double footstep_planner::State::getTheta |
( |
|
) |
const [inline] |
| double footstep_planner::State::getX |
( |
|
) |
const [inline] |
| double footstep_planner::State::getY |
( |
|
) |
const [inline] |
| bool footstep_planner::State::operator!= |
( |
const State & |
s2 |
) |
const |
Inequality operator for two states (negates the equality operator).
Definition at line 59 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 47 of file State.cpp.
| void footstep_planner::State::setLeg |
( |
Leg |
leg |
) |
[inline] |
| void footstep_planner::State::setTheta |
( |
double |
theta |
) |
[inline] |
| void footstep_planner::State::setX |
( |
double |
x |
) |
[inline] |
| void footstep_planner::State::setY |
( |
double |
y |
) |
[inline] |
Member Data Documentation
The robot's supporting leg.
Definition at line 74 of file State.h.
The robot's orientation.
Definition at line 72 of file State.h.
The robot's position in x direction.
Definition at line 68 of file State.h.
The robot's position in y direction.
Definition at line 70 of file State.h.
The documentation for this class was generated from the following files:
