ompl::base::GoalState Class Reference

Definition of a goal state. More...

#include <GoalState.h>

Inheritance diagram for ompl::base::GoalState:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual double distanceGoal (const State *st) const
 Compute the distance to the goal (heuristic).
 GoalState (const SpaceInformationPtr &si)
 Create a goal representation that is in fact a state.
virtual unsigned int maxSampleCount (void) const
 Return the maximum number of samples that can be asked for before repeating.
virtual void print (std::ostream &out=std::cout) const
 Print information about the goal data structure to a stream.
virtual void sampleGoal (State *st) const
 Sample a state in the goal region.
void setState (const ScopedState<> &st)
 Set the goal state.
void setState (const State *st)
 Set the goal state.
virtual ~GoalState (void)

Public Attributes

Statestate
 The goal state.

Detailed Description

Definition of a goal state.

Definition at line 50 of file GoalState.h.


Constructor & Destructor Documentation

ompl::base::GoalState::GoalState ( const SpaceInformationPtr si  )  [inline]

Create a goal representation that is in fact a state.

Definition at line 55 of file GoalState.h.

virtual ompl::base::GoalState::~GoalState ( void   )  [virtual]

Member Function Documentation

virtual double ompl::base::GoalState::distanceGoal ( const State st  )  const [virtual]

Compute the distance to the goal (heuristic).

Implements ompl::base::GoalRegion.

virtual unsigned int ompl::base::GoalState::maxSampleCount ( void   )  const [virtual]

Return the maximum number of samples that can be asked for before repeating.

Implements ompl::base::GoalSampleableRegion.

virtual void ompl::base::GoalState::print ( std::ostream &  out = std::cout  )  const [virtual]

Print information about the goal data structure to a stream.

Reimplemented from ompl::base::GoalRegion.

virtual void ompl::base::GoalState::sampleGoal ( State st  )  const [virtual]

Sample a state in the goal region.

Implements ompl::base::GoalSampleableRegion.

void ompl::base::GoalState::setState ( const ScopedState<> &  st  ) 

Set the goal state.

void ompl::base::GoalState::setState ( const State st  ) 

Set the goal state.


Member Data Documentation

The goal state.

Definition at line 81 of file GoalState.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


ompl
Author(s): Ioan Sucan/isucan@rice.edu, Mark Moll/mmoll@rice.edu, Lydia Kavraki/kavraki@rice.edu
autogenerated on Fri Jan 11 09:33:59 2013