ompl::base::PlannerDataVertex Class Reference

Base class for a vertex in the PlannerData structure. All derived classes must implement the clone and equivalence operators. It is assumed that each vertex in the PlannerData structure is unique (i.e. no duplicates allowed). More...

#include <ompl/base/PlannerData.h>

Public Member Functions

 PlannerDataVertex (const State *st, int tag=0)
 Constructor. Takes a state pointer and an optional integer tag.
 
 PlannerDataVertex (const PlannerDataVertex &rhs)=default
 Copy constructor.
 
virtual int getTag () const
 Returns the integer tag associated with this vertex.
 
virtual void setTag (int tag)
 Set the integer tag associated with this vertex.
 
virtual const StategetState () const
 Retrieve the state associated with this vertex.
 
virtual PlannerDataVertexclone () const
 Return a clone of this object, allocated from the heap.
 
virtual bool operator== (const PlannerDataVertex &rhs) const
 Equivalence operator. Return true if the state pointers are equal.
 
bool operator!= (const PlannerDataVertex &rhs) const
 Returns true if this vertex is not equal to the argument. This is the complement of the == operator.
 

Protected Member Functions

template<class Archive >
void serialize (Archive &ar, const unsigned int)
 

Protected Attributes

const Statestate_
 The state represented by this vertex.
 
int tag_
 A generic integer tag for this state. Not used for equivalence checking.
 

Friends

class boost::serialization::access
 
class PlannerData
 
class PlannerDataStorage
 

Detailed Description

Base class for a vertex in the PlannerData structure. All derived classes must implement the clone and equivalence operators. It is assumed that each vertex in the PlannerData structure is unique (i.e. no duplicates allowed).

Definition at line 58 of file PlannerData.h.


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