Public Member Functions | Protected Attributes | Friends | List of all members
ompl::multilevel::PathRestriction Class Reference

Representation of path restriction (union of fibers over a base path). More...

#include <ompl/multilevel/datastructures/pathrestriction/PathRestriction.h>

Public Member Functions

 PathRestriction (BundleSpaceGraph *)
 
virtual void clear ()
 
void setBasePath (base::PathPtr)
 Set base path over which restriction is defined.
 
void setBasePath (std::vector< base::State * >)
 Set base path over which restriction is defined.
 
const std::vector< base::State * > & getBasePath () const
 Return discrete states representation of base path.
 
void setFindSectionStrategy (FindSectionType type)
 Choose algorithm to find sections over restriction.
 
bool hasFeasibleSection (Configuration *const, Configuration *const)
 Check if feasible section exists between xStart and xGoal. More...
 
BundleSpaceGraph * getBundleSpaceGraph ()
 Return pointer to underlying bundle space graph.
 
double getLengthBasePath () const
 Length of base path.
 
unsigned int size () const
 Return number of discrete states in base path.
 
const base::State * getBaseStateAt (int k) const
 Return State at index k on base path.
 
double getLengthIntermediateBasePath (int k)
 Length between base state indices k and k+1.
 
double getLengthBasePathUntil (int k)
 Cumulative length until base state index k.
 
int getBasePathLastIndexFromLocation (double d)
 Given a position d in [0, lengthbasepath_], return the index of the nearest state on base path before d.
 
void interpolateBasePath (double t, base::State *&state) const
 Interpolate state on base path at position t in [0, lengthbasepath_] (using discrete state representation)
 
virtual void print (std::ostream &) const
 

Protected Attributes

BundleSpaceGraph * bundleSpaceGraph_
 Pointer to associated bundle space.
 
std::vector< base::State * > basePath_
 Base path over which we define the restriction.
 
double lengthBasePath_ {0.0}
 Length of set base path.
 
std::vector< double > lengthsIntermediateBasePath_
 Intermediate lengths between states on base path.
 
std::vector< double > lengthsCumulativeBasePath_
 Cumulative lengths between states on base path.
 
FindSectionPtr findSection_
 Strategy to find a feasible section (between specific elements on fiber at first base path index and fiber at last base path index)
 

Friends

std::ostream & operator<< (std::ostream &, const PathRestriction &)
 

Detailed Description

Representation of path restriction (union of fibers over a base path).

Class represents path restriction by keeping a set of discrete base path states. To access states inbetween, we use the interpolateBasePath method. To find a feasible section over a path restriction, we use the strategy pattern FindSection, which has different implementations.

To use this class, you need to set a base path (setBasePath), then you can search for sections over this base path (using hasFeasibleSection). Internally, this calls the FindSection algorithm, which can be changed in Constructor method. Please see the class ompl::multilevel::FindSection for details on finding feasible sections.

External documentation
A. Orthey and M. Toussaint, Section Patterns: Efficiently Solving Narrow Passage Problems using Multilevel Motion Planning, arXiv:2010.14524 [cs.RO], 2020 [PDF]

Definition at line 132 of file PathRestriction.h.

Member Function Documentation

◆ hasFeasibleSection()

bool PathRestriction::hasFeasibleSection ( Configuration * const  xStart,
Configuration * const  xGoal 
)

Check if feasible section exists between xStart and xGoal.

NOTE: "const ptr*" means that the pointer itself is const "ptr* const" means that the content of the pointer is const (but ptr can change)

Definition at line 205 of file PathRestriction.cpp.

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