Aikido
aikido::planner::ConfigurationToConfigurationPlanner Class Referenceabstract

Base planner class for ConfigurationToConfiguration planning problem. More...

#include <aikido/planner/ConfigurationToConfigurationPlanner.hpp>

Inheritance diagram for aikido::planner::ConfigurationToConfigurationPlanner:
aikido::planner::SingleProblemPlanner< ConfigurationToConfigurationPlanner, ConfigurationToConfiguration > aikido::planner::Planner aikido::planner::ompl::OMPLConfigurationToConfigurationPlanner< PlannerType > aikido::planner::SnapConfigurationToConfigurationPlanner

Public Member Functions

 ConfigurationToConfigurationPlanner (statespace::ConstStateSpacePtr stateSpace, common::RNG *rng=nullptr)
 Constructs from a state space. More...
 
virtual trajectory::TrajectoryPtr plan (const SolvableProblem &problem, Result *result=nullptr)=0
 Solves problem returning the result to result. More...
 
trajectory::TrajectoryPtr plan (const Problem &problem, Result *result=nullptr) final override
 
- Public Member Functions inherited from aikido::planner::SingleProblemPlanner< ConfigurationToConfigurationPlanner, ConfigurationToConfiguration >
 SingleProblemPlanner (statespace::ConstStateSpacePtr stateSpace, common::RNG *rng=nullptr)
 
bool canSolve (const Problem &problem) const final override
 Returns true if this planner can solve problem. More...
 
trajectory::TrajectoryPtr plan (const Problem &problem, Result *result=nullptr) final override
 Solves problem returning the result to result. More...
 
- Public Member Functions inherited from aikido::planner::Planner
 Planner (statespace::ConstStateSpacePtr stateSpace, common::RNG *rng=nullptr)
 Constructs from a state space. More...
 
virtual ~Planner ()=default
 Default destructor. More...
 
statespace::ConstStateSpacePtr getStateSpace () const
 Returns const state space. More...
 
common::RNGgetRng ()
 Returns RNG. More...
 

Additional Inherited Members

- Public Types inherited from aikido::planner::SingleProblemPlanner< ConfigurationToConfigurationPlanner, ConfigurationToConfiguration >
using SolvableProblem = ConfigurationToConfiguration
 
- Protected Attributes inherited from aikido::planner::Planner
statespace::ConstStateSpacePtr mStateSpace
 State space associated with this planner. More...
 
std::unique_ptr< common::RNGmRng
 RNG the planner uses. More...
 

Detailed Description

Base planner class for ConfigurationToConfiguration planning problem.

Constructor & Destructor Documentation

◆ ConfigurationToConfigurationPlanner()

aikido::planner::ConfigurationToConfigurationPlanner::ConfigurationToConfigurationPlanner ( statespace::ConstStateSpacePtr  stateSpace,
common::RNG rng = nullptr 
)
explicit

Constructs from a state space.

Parameters
[in]stateSpaceState space that this planner associated with.
[in]rngRNG that planner uses. If nullptr, a default is created.

Member Function Documentation

◆ plan() [1/2]

trajectory::TrajectoryPtr aikido::planner::SingleProblemPlanner< Derived, ProblemT >::plan
finaloverride

◆ plan() [2/2]

virtual trajectory::TrajectoryPtr aikido::planner::ConfigurationToConfigurationPlanner::plan ( const SolvableProblem problem,
Result result = nullptr 
)
pure virtual

Solves problem returning the result to result.

Parameters
[in]problemPlanning problem to be solved by the planner.
[out]resultResult of planning procedure.

Implemented in aikido::planner::SnapConfigurationToConfigurationPlanner.