Aikido
aikido::planner::ConfigurationToConfiguration Class Reference

Planning problem to plan to a single goal configuration. More...

#include <aikido/planner/ConfigurationToConfiguration.hpp>

Inheritance diagram for aikido::planner::ConfigurationToConfiguration:
aikido::planner::Problem

Public Member Functions

 ConfigurationToConfiguration (statespace::ConstStateSpacePtr stateSpace, const statespace::StateSpace::State *startState, const statespace::StateSpace::State *goalState, constraint::ConstTestablePtr constraint)
 Constructor. More...
 
const std::string & getType () const override
 Returns type of this planning problem. More...
 
const statespace::StateSpace::StategetStartState () const
 Returns the start state. More...
 
const statespace::StateSpace::StategetGoalState () const
 Returns the goal state. More...
 
- Public Member Functions inherited from aikido::planner::Problem
 Problem (statespace::ConstStateSpacePtr stateSpace, constraint::ConstTestablePtr constraint=nullptr)
 Constructor. More...
 
virtual ~Problem ()=default
 Destructor. More...
 
statespace::ConstStateSpacePtr getStateSpace () const
 Returns const state space. More...
 
constraint::ConstTestablePtr getConstraint () const
 Returns the constraint that must be satisfied throughout the trajectory. More...
 

Static Public Member Functions

static const std::string & getStaticType ()
 Returns the type of the planning problem. More...
 

Protected Attributes

statespace::StateSpace::ScopedState mStartState
 Start state. More...
 
statespace::StateSpace::ScopedState mGoalState
 Goal state. More...
 
- Protected Attributes inherited from aikido::planner::Problem
statespace::ConstStateSpacePtr mStateSpace
 State space associated with this problem. More...
 
constraint::ConstTestablePtr mConstraint
 Trajectory-wide constraint that must be satisfied. More...
 

Detailed Description

Planning problem to plan to a single goal configuration.

Constructor & Destructor Documentation

◆ ConfigurationToConfiguration()

aikido::planner::ConfigurationToConfiguration::ConfigurationToConfiguration ( statespace::ConstStateSpacePtr  stateSpace,
const statespace::StateSpace::State startState,
const statespace::StateSpace::State goalState,
constraint::ConstTestablePtr  constraint 
)

Constructor.

Parameters
[in]stateSpaceState space that this problem associated with.
[in]startStateStart state.
[in]goalStateGoal state.
[in]constraintTrajectory-wide constraint that must be satisfied.
Exceptions
IfstateSpace is not compatible with constraint's state space.

Member Function Documentation

◆ getGoalState()

const statespace::StateSpace::State* aikido::planner::ConfigurationToConfiguration::getGoalState ( ) const

Returns the goal state.

◆ getStartState()

const statespace::StateSpace::State* aikido::planner::ConfigurationToConfiguration::getStartState ( ) const

Returns the start state.

◆ getStaticType()

static const std::string& aikido::planner::ConfigurationToConfiguration::getStaticType ( )
static

Returns the type of the planning problem.

◆ getType()

const std::string& aikido::planner::ConfigurationToConfiguration::getType ( ) const
overridevirtual

Returns type of this planning problem.

Implements aikido::planner::Problem.

Member Data Documentation

◆ mGoalState

statespace::StateSpace::ScopedState aikido::planner::ConfigurationToConfiguration::mGoalState
protected

Goal state.

◆ mStartState

statespace::StateSpace::ScopedState aikido::planner::ConfigurationToConfiguration::mStartState
protected

Start state.