An annotated vertex, adding information about its level in the quotient-space hiearchy, the maxlevel of quotientspaces and the component it belongs to. More...
#include <ompl/geometric/planners/quotientspace/datastructures/PlannerDataVertexAnnotated.h>

Public Member Functions | |
PlannerDataVertexAnnotated (const ompl::base::State *st, int tag=0) | |
PlannerDataVertexAnnotated (const PlannerDataVertexAnnotated &rhs) | |
virtual PlannerDataVertex * | clone () const override |
Return a clone of this object, allocated from the heap. More... | |
void | setLevel (unsigned int level_) |
unsigned int | getLevel () const |
void | setMaxLevel (unsigned int level_) |
unsigned int | getMaxLevel () const |
void | setPath (std::vector< int > path_) |
std::vector< int > | getPath () const |
void | setComponent (unsigned int component_) |
unsigned int | getComponent () const |
void | setState (ompl::base::State *s) |
void | setQuotientState (const ompl::base::State *s) |
virtual const ompl::base::State * | getState () const override |
Retrieve the state associated with this vertex. More... | |
virtual const ompl::base::State * | getQuotientState () const |
![]() | |
PlannerDataVertex (const State *st, int tag=0) | |
Constructor. Takes a state pointer and an optional integer tag. More... | |
PlannerDataVertex (const PlannerDataVertex &rhs)=default | |
Copy constructor. | |
virtual int | getTag () const |
Returns the integer tag associated with this vertex. More... | |
virtual void | setTag (int tag) |
Set the integer tag associated with this vertex. More... | |
virtual const State * | getState () const |
Retrieve the state associated with this vertex. More... | |
virtual PlannerDataVertex * | clone () const |
Return a clone of this object, allocated from the heap. More... | |
virtual bool | operator== (const PlannerDataVertex &rhs) const |
Equivalence operator. Return true if the state pointers are equal. More... | |
bool | operator!= (const PlannerDataVertex &rhs) const |
Returns true if this vertex is not equal to the argument. This is the complement of the == operator. More... | |
Protected Attributes | |
unsigned int | level_ {0} |
unsigned int | maxLevel_ {1} |
std::vector< int > | path_ |
unsigned int | component_ {0} |
const ompl::base::State * | stateQuotientSpace_ {nullptr} |
![]() | |
const State * | state_ |
The state represented by this vertex. More... | |
int | tag_ |
A generic integer tag for this state. Not used for equivalence checking. More... | |
Friends | |
bool | operator== (const PlannerDataVertexAnnotated &lhs, const PlannerDataVertexAnnotated &rhs) |
std::ostream & | operator<< (std::ostream &, const PlannerDataVertexAnnotated &) |
Additional Inherited Members | |
![]() | |
template<class Archive > | |
void | serialize (Archive &ar, const unsigned int) |
Detailed Description
An annotated vertex, adding information about its level in the quotient-space hiearchy, the maxlevel of quotientspaces and the component it belongs to.
Definition at line 51 of file PlannerDataVertexAnnotated.h.
Constructor & Destructor Documentation
◆ PlannerDataVertexAnnotated() [1/2]
ompl::base::PlannerDataVertexAnnotated::PlannerDataVertexAnnotated | ( | const ompl::base::State * | st, |
int | tag = 0 |
||
) |
Definition at line 39 of file PlannerDataVertexAnnotated.cpp.
◆ PlannerDataVertexAnnotated() [2/2]
ompl::base::PlannerDataVertexAnnotated::PlannerDataVertexAnnotated | ( | const PlannerDataVertexAnnotated & | rhs | ) |
Definition at line 44 of file PlannerDataVertexAnnotated.cpp.
Member Function Documentation
◆ clone()
|
overridevirtual |
Return a clone of this object, allocated from the heap.
Reimplemented from ompl::base::PlannerDataVertex.
Definition at line 54 of file PlannerDataVertexAnnotated.cpp.
◆ getComponent()
unsigned int ompl::base::PlannerDataVertexAnnotated::getComponent | ( | ) | const |
Definition at line 64 of file PlannerDataVertexAnnotated.cpp.
◆ getLevel()
unsigned int ompl::base::PlannerDataVertexAnnotated::getLevel | ( | ) | const |
Definition at line 74 of file PlannerDataVertexAnnotated.cpp.
◆ getMaxLevel()
unsigned int ompl::base::PlannerDataVertexAnnotated::getMaxLevel | ( | ) | const |
Definition at line 84 of file PlannerDataVertexAnnotated.cpp.
◆ getPath()
std::vector< int > ompl::base::PlannerDataVertexAnnotated::getPath | ( | ) | const |
Definition at line 94 of file PlannerDataVertexAnnotated.cpp.
◆ getQuotientState()
|
virtual |
Definition at line 104 of file PlannerDataVertexAnnotated.cpp.
◆ getState()
|
overridevirtual |
Retrieve the state associated with this vertex.
Reimplemented from ompl::base::PlannerDataVertex.
Definition at line 99 of file PlannerDataVertexAnnotated.cpp.
◆ setComponent()
void ompl::base::PlannerDataVertexAnnotated::setComponent | ( | unsigned int | component_ | ) |
Definition at line 59 of file PlannerDataVertexAnnotated.cpp.
◆ setLevel()
void ompl::base::PlannerDataVertexAnnotated::setLevel | ( | unsigned int | level_ | ) |
Definition at line 69 of file PlannerDataVertexAnnotated.cpp.
◆ setMaxLevel()
void ompl::base::PlannerDataVertexAnnotated::setMaxLevel | ( | unsigned int | level_ | ) |
Definition at line 79 of file PlannerDataVertexAnnotated.cpp.
◆ setPath()
void ompl::base::PlannerDataVertexAnnotated::setPath | ( | std::vector< int > | path_ | ) |
Definition at line 89 of file PlannerDataVertexAnnotated.cpp.
◆ setQuotientState()
void ompl::base::PlannerDataVertexAnnotated::setQuotientState | ( | const ompl::base::State * | s | ) |
Definition at line 109 of file PlannerDataVertexAnnotated.cpp.
◆ setState()
void ompl::base::PlannerDataVertexAnnotated::setState | ( | ompl::base::State * | s | ) |
Definition at line 114 of file PlannerDataVertexAnnotated.cpp.
Friends And Related Function Documentation
◆ operator<<
|
friend |
Definition at line 124 of file PlannerDataVertexAnnotated.cpp.
◆ operator==
|
friend |
Definition at line 119 of file PlannerDataVertexAnnotated.cpp.
Member Data Documentation
◆ component_
|
protected |
Definition at line 86 of file PlannerDataVertexAnnotated.h.
◆ level_
|
protected |
Definition at line 81 of file PlannerDataVertexAnnotated.h.
◆ maxLevel_
|
protected |
Definition at line 82 of file PlannerDataVertexAnnotated.h.
◆ path_
|
protected |
Definition at line 84 of file PlannerDataVertexAnnotated.h.
◆ stateQuotientSpace_
|
protected |
Definition at line 87 of file PlannerDataVertexAnnotated.h.
The documentation for this class was generated from the following files:
- ompl/geometric/planners/quotientspace/datastructures/PlannerDataVertexAnnotated.h
- ompl/geometric/planners/quotientspace/datastructures/src/PlannerDataVertexAnnotated.cpp