Loading...
Searching...
No Matches
ompl::control::PlannerDataEdgeControl Class Reference

Representation of an edge in PlannerData for planning with controls. This structure encodes a specific control and a duration to apply the control. More...

#include <ompl/control/PlannerData.h>

Inheritance diagram for ompl::control::PlannerDataEdgeControl:

Public Member Functions

 PlannerDataEdgeControl (const Control *c, double duration)
 Constructor. Accepts a control pointer and a duration.
 
 PlannerDataEdgeControl (const PlannerDataEdgeControl &rhs)
 Copy constructor.
 
base::PlannerDataEdgeclone () const override
 Return a clone of this object, allocated from the heap.
 
const ControlgetControl () const
 Return the control associated with this edge.
 
double getDuration () const
 Return the duration associated with this edge.
 
bool operator== (const PlannerDataEdge &rhs) const override
 
- Public Member Functions inherited from ompl::base::PlannerDataEdge
virtual bool operator== (const PlannerDataEdge &rhs) const
 Returns true if the edges point to the same memory.
 
bool operator!= (const PlannerDataEdge &rhs) const
 Returns true if the edges do not point to the same memory. This is the complement of the == operator.
 

Protected Member Functions

template<class Archive >
void serialize (Archive &ar, const unsigned int)
 
- Protected Member Functions inherited from ompl::base::PlannerDataEdge
template<class Archive >
void serialize (Archive &, const unsigned int)
 

Protected Attributes

const Controlc_ {nullptr}
 
double duration_
 

Friends

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

Detailed Description

Representation of an edge in PlannerData for planning with controls. This structure encodes a specific control and a duration to apply the control.

Remarks
If using PlannerDataEdgeControl in conjunction with PlannerDataStorage, (i.e., storing the PlannerData from a controls planner) you must export a GUID for PlannerDataEdgeControl so that the serializer can identify the derived edge class:
#include <boost/serialization/export.hpp>
...
Representation of an edge in PlannerData for planning with controls. This structure encodes a specifi...
Definition PlannerData.h:61

Definition at line 60 of file PlannerData.h.

Constructor & Destructor Documentation

◆ PlannerDataEdgeControl() [1/2]

ompl::control::PlannerDataEdgeControl::PlannerDataEdgeControl ( const Control c,
double  duration 
)
inline

Constructor. Accepts a control pointer and a duration.

Definition at line 64 of file PlannerData.h.

◆ PlannerDataEdgeControl() [2/2]

ompl::control::PlannerDataEdgeControl::PlannerDataEdgeControl ( const PlannerDataEdgeControl rhs)
inline

Copy constructor.

Definition at line 68 of file PlannerData.h.

Member Function Documentation

◆ clone()

base::PlannerDataEdge * ompl::control::PlannerDataEdgeControl::clone ( ) const
inlineoverridevirtual

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

Reimplemented from ompl::base::PlannerDataEdge.

Definition at line 75 of file PlannerData.h.

◆ getControl()

const Control * ompl::control::PlannerDataEdgeControl::getControl ( ) const
inline

Return the control associated with this edge.

Definition at line 81 of file PlannerData.h.

◆ getDuration()

double ompl::control::PlannerDataEdgeControl::getDuration ( ) const
inline

Return the duration associated with this edge.

Definition at line 86 of file PlannerData.h.

◆ operator==()

bool ompl::control::PlannerDataEdgeControl::operator== ( const PlannerDataEdge &  rhs) const
inlineoverride

Definition at line 91 of file PlannerData.h.

◆ serialize()

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

Definition at line 107 of file PlannerData.h.

Friends And Related Symbol Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Definition at line 100 of file PlannerData.h.

◆ PlannerData

friend class PlannerData
friend

Definition at line 102 of file PlannerData.h.

◆ PlannerDataStorage

friend class PlannerDataStorage
friend

Definition at line 101 of file PlannerData.h.

Member Data Documentation

◆ c_

const Control* ompl::control::PlannerDataEdgeControl::c_ {nullptr}
protected

Definition at line 114 of file PlannerData.h.

◆ duration_

double ompl::control::PlannerDataEdgeControl::duration_
protected

Definition at line 115 of file PlannerData.h.


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