|
| RRT (const SpaceInformationPtr &si) |
| Constructor.
|
|
base::PlannerStatus | solve (const base::PlannerTerminationCondition &ptc) override |
| Continue solving for some amount of time. Return true if solution was found.
|
|
void | clear () override |
| Clear datastructures. Call this function if the input data to the planner has changed and you do not want to continue planning.
|
|
void | setGoalBias (double goalBias) |
|
double | getGoalBias () const |
| Get the goal bias the planner is using.
|
|
bool | getIntermediateStates () const |
| Return true if the intermediate states generated along motions are to be added to the tree itself.
|
|
void | setIntermediateStates (bool addIntermediateStates) |
| Specify whether the intermediate states generated along motions are to be added to the tree itself.
|
|
void | getPlannerData (base::PlannerData &data) const override |
| Get information about the current run of the motion planner. Repeated calls to this function will update data (only additions are made). This is useful to see what changed in the exploration datastructure, between calls to solve(), for example (without calling clear() in between).
|
|
template<template< typename T > class NN> |
void | setNearestNeighbors () |
| Set a different nearest neighbors datastructure.
|
|
void | setup () override |
| Perform extra configuration steps, if needed. This call will also issue a call to ompl::base::SpaceInformation::setup() if needed. This must be called before solving.
|
|
| Planner (const Planner &)=delete |
|
Planner & | operator= (const Planner &)=delete |
|
| Planner (SpaceInformationPtr si, std::string name) |
| Constructor.
|
|
virtual | ~Planner ()=default |
| Destructor.
|
|
template<class T > |
T * | as () |
| Cast this instance to a desired type.
|
|
template<class T > |
const T * | as () const |
| Cast this instance to a desired type.
|
|
const SpaceInformationPtr & | getSpaceInformation () const |
| Get the space information this planner is using.
|
|
const ProblemDefinitionPtr & | getProblemDefinition () const |
| Get the problem definition the planner is trying to solve.
|
|
ProblemDefinitionPtr & | getProblemDefinition () |
| Get the problem definition the planner is trying to solve.
|
|
const PlannerInputStates & | getPlannerInputStates () const |
| Get the planner input states.
|
|
virtual void | setProblemDefinition (const ProblemDefinitionPtr &pdef) |
| Set the problem definition for the planner. The problem needs to be set before calling solve(). Note: If this problem definition replaces a previous one, it may also be necessary to call clear() or clearQuery().
|
|
virtual PlannerStatus | solve (const PlannerTerminationCondition &ptc)=0 |
| Function that can solve the motion planning problem. This function can be called multiple times on the same problem, without calling clear() in between. This allows the planner to continue work for more time on an unsolved problem, for example. If this option is used, it is assumed the problem definition is not changed (unpredictable results otherwise). The only change in the problem definition that is accounted for is the addition of starting or goal states (but not changing previously added start/goal states). If clearQuery() is called, the planner may retain prior datastructures generated from a previous query on a new problem definition. The function terminates if the call to ptc returns true.
|
|
PlannerStatus | solve (const PlannerTerminationConditionFn &ptc, double checkInterval) |
| Same as above except the termination condition is only evaluated at a specified interval.
|
|
PlannerStatus | solve (double solveTime) |
| Same as above except the termination condition is solely a time limit: the number of seconds the algorithm is allowed to spend planning.
|
|
virtual void | clear () |
| Clear all internal datastructures. Planner settings are not affected. Subsequent calls to solve() will ignore all previous work.
|
|
virtual void | clearQuery () |
| Clears internal datastructures of any query-specific information from the previous query. Planner settings are not affected. The planner, if able, should retain all datastructures generated from previous queries that can be used to help solve the next query. Note that clear() should also clear all query-specific information along with all other datastructures in the planner. By default clearQuery() calls clear().
|
|
virtual void | getPlannerData (PlannerData &data) const |
| Get information about the current run of the motion planner. Repeated calls to this function will update data (only additions are made). This is useful to see what changed in the exploration datastructure, between calls to solve(), for example (without calling clear() in between).
|
|
const std::string & | getName () const |
| Get the name of the planner.
|
|
void | setName (const std::string &name) |
| Set the name of the planner.
|
|
const PlannerSpecs & | getSpecs () const |
| Return the specifications (capabilities of this planner)
|
|
virtual void | setup () |
| Perform extra configuration steps, if needed. This call will also issue a call to ompl::base::SpaceInformation::setup() if needed. This must be called before solving.
|
|
virtual void | checkValidity () |
| Check to see if the planner is in a working state (setup has been called, a goal was set, the input states seem to be in order). In case of error, this function throws an exception.
|
|
bool | isSetup () const |
| Check if setup() was called for this planner.
|
|
ParamSet & | params () |
| Get the parameters for this planner.
|
|
const ParamSet & | params () const |
| Get the parameters for this planner.
|
|
const PlannerProgressProperties & | getPlannerProgressProperties () const |
| Retrieve a planner's planner progress property map.
|
|
virtual void | printProperties (std::ostream &out) const |
| Print properties of the motion planner.
|
|
virtual void | printSettings (std::ostream &out) const |
| Print information about the motion planner's settings.
|
|
|
void | freeMemory () |
| Free the memory allocated by this planner.
|
|
double | distanceFunction (const Motion *a, const Motion *b) const |
| Compute distance between motions (actually distance between contained states)
|
|
template<typename T , typename PlannerType , typename SetterType , typename GetterType > |
void | declareParam (const std::string &name, const PlannerType &planner, const SetterType &setter, const GetterType &getter, const std::string &rangeSuggestion="") |
| This function declares a parameter for this planner instance, and specifies the setter and getter functions.
|
|
template<typename T , typename PlannerType , typename SetterType > |
void | declareParam (const std::string &name, const PlannerType &planner, const SetterType &setter, const std::string &rangeSuggestion="") |
| This function declares a parameter for this planner instance, and specifies the setter function.
|
|
void | addPlannerProgressProperty (const std::string &progressPropertyName, const PlannerProgressProperty &prop) |
| Add a planner progress property called progressPropertyName with a property querying function prop to this planner's progress property map.
|
|
Rapidly-exploring Random Tree.
- Short description
- RRT is a tree-based motion planner that uses the following idea: RRT samples a random state qr in the state space, then finds the state qc among the previously seen states that is closest to qr and expands from qc towards qr, until a state qm is reached. qm is then added to the exploration tree. This implementation is intended for systems with differential constraints.
- External documentation
- S.M. LaValle and J.J. Kuffner, Randomized kinodynamic planning, Intl. J. of Robotics Research, vol. 20, pp. 378–400, May 2001. DOI: 10.1177/02783640122067453
[PDF] [more]
Definition at line 65 of file RRT.h.