Loading...
Searching...
No Matches

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>

Inheritance diagram for ompl::base::PlannerDataVertex:

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.

Constructor & Destructor Documentation

◆ PlannerDataVertex()

ompl::base::PlannerDataVertex::PlannerDataVertex ( const State * st,
int tag = 0 )
inline

Constructor. Takes a state pointer and an optional integer tag.

Definition at line 62 of file PlannerData.h.

Member Function Documentation

◆ clone()

virtual PlannerDataVertex * ompl::base::PlannerDataVertex::clone ( ) const
inlinevirtual

Return a clone of this object, allocated from the heap.

Reimplemented in ompl::base::PlannerDataVertexAnnotated.

Definition at line 86 of file PlannerData.h.

◆ getState()

virtual const State * ompl::base::PlannerDataVertex::getState ( ) const
inlinevirtual

Retrieve the state associated with this vertex.

Reimplemented in ompl::base::PlannerDataVertexAnnotated.

Definition at line 80 of file PlannerData.h.

◆ getTag()

virtual int ompl::base::PlannerDataVertex::getTag ( ) const
inlinevirtual

Returns the integer tag associated with this vertex.

Definition at line 70 of file PlannerData.h.

◆ operator!=()

bool ompl::base::PlannerDataVertex::operator!= ( const PlannerDataVertex & rhs) const
inline

Returns true if this vertex is not equal to the argument. This is the complement of the == operator.

Definition at line 100 of file PlannerData.h.

◆ operator==()

virtual bool ompl::base::PlannerDataVertex::operator== ( const PlannerDataVertex & rhs) const
inlinevirtual

Equivalence operator. Return true if the state pointers are equal.

Definition at line 92 of file PlannerData.h.

◆ serialize()

template<class Archive >
void ompl::base::PlannerDataVertex::serialize ( Archive & ar,
const unsigned int  )
inlineprotected

Definition at line 110 of file PlannerData.h.

◆ setTag()

virtual void ompl::base::PlannerDataVertex::setTag ( int tag)
inlinevirtual

Set the integer tag associated with this vertex.

Definition at line 75 of file PlannerData.h.

Friends And Related Symbol Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Definition at line 108 of file PlannerData.h.

◆ PlannerData

friend class PlannerData
friend

Definition at line 121 of file PlannerData.h.

◆ PlannerDataStorage

friend class PlannerDataStorage
friend

Definition at line 122 of file PlannerData.h.

Member Data Documentation

◆ state_

const State* ompl::base::PlannerDataVertex::state_
protected

The state represented by this vertex.

Definition at line 117 of file PlannerData.h.

◆ tag_

int ompl::base::PlannerDataVertex::tag_
protected

A generic integer tag for this state. Not used for equivalence checking.

Definition at line 119 of file PlannerData.h.


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