hpp-manipulation  4.9.0
Classes for manipulation planning.
hpp::manipulation::graph::StateSelector Class Reference

#include <hpp/manipulation/graph/state-selector.hh>

Inheritance diagram for hpp::manipulation::graph::StateSelector:

Public Member Functions

virtual ~StateSelector ()
 
const std::string & name () const
 
StatePtr_t createState (const std::string &name, bool waypoint=false, const int w=0)
 Create an empty state. More...
 
StatePtr_t getState (ConfigurationIn_t config) const
 Returns the state of a configuration. More...
 
StatePtr_t getState (RoadmapNodePtr_t node) const
 Returns the state of a roadmap state. More...
 
States_t getStates () const
 Returns a list of all the states. More...
 
States_t getWaypointStates () const
 Returns a list of all the states. More...
 
virtual EdgePtr_t chooseEdge (RoadmapNodePtr_t from) const
 Select randomly an outgoing edge of the given state. More...
 
virtual std::ostream & dotPrint (std::ostream &os, dot::DrawingAttributes da=dot::DrawingAttributes()) const
 Print the object in a stream. More...
 
void parentGraph (const GraphWkPtr_t &parent)
 Set the parent graph. More...
 
GraphPtr_t parentGraph () const
 Set the parent graph. More...
 

Static Public Member Functions

static StateSelectorPtr_t create (const std::string &name)
 Create a new StateSelector. More...
 

Protected Types

typedef std::pair< int, StatePtr_tWeighedState_t
 List of the states of one end-effector, ordered by priority. More...
 
typedef std::list< WeighedState_tWeighedStates_t
 

Protected Member Functions

void init (const StateSelectorPtr_t &weak)
 Initialization of the object. More...
 
 StateSelector (const std::string &name)
 Constructor. More...
 
virtual std::ostream & print (std::ostream &os) const
 Print the object in a stream. More...
 

Protected Attributes

WeighedStates_t orderedStates_
 
States_t waypoints_
 

Friends

std::ostream & operator<< (std::ostream &os, const StateSelector &ss)
 

Detailed Description

This class is used to get the state of a configuration. States have to be ordered because a configuration can be in several states.

Member Typedef Documentation

◆ WeighedState_t

List of the states of one end-effector, ordered by priority.

◆ WeighedStates_t

Constructor & Destructor Documentation

◆ ~StateSelector()

virtual hpp::manipulation::graph::StateSelector::~StateSelector ( )
inlinevirtual

◆ StateSelector()

hpp::manipulation::graph::StateSelector::StateSelector ( const std::string &  name)
inlineprotected

Constructor.

Member Function Documentation

◆ chooseEdge()

virtual EdgePtr_t hpp::manipulation::graph::StateSelector::chooseEdge ( RoadmapNodePtr_t  from) const
virtual

Select randomly an outgoing edge of the given state.

Reimplemented in hpp::manipulation::graph::GuidedStateSelector.

◆ create()

static StateSelectorPtr_t hpp::manipulation::graph::StateSelector::create ( const std::string &  name)
static

Create a new StateSelector.

◆ createState()

StatePtr_t hpp::manipulation::graph::StateSelector::createState ( const std::string &  name,
bool  waypoint = false,
const int  w = 0 
)

Create an empty state.

◆ dotPrint()

virtual std::ostream& hpp::manipulation::graph::StateSelector::dotPrint ( std::ostream &  os,
dot::DrawingAttributes  da = dot::DrawingAttributes() 
) const
virtual

Print the object in a stream.

Reimplemented in hpp::manipulation::graph::GuidedStateSelector.

◆ getState() [1/2]

StatePtr_t hpp::manipulation::graph::StateSelector::getState ( ConfigurationIn_t  config) const

Returns the state of a configuration.

◆ getState() [2/2]

StatePtr_t hpp::manipulation::graph::StateSelector::getState ( RoadmapNodePtr_t  node) const

Returns the state of a roadmap state.

◆ getStates()

States_t hpp::manipulation::graph::StateSelector::getStates ( ) const

Returns a list of all the states.

◆ getWaypointStates()

States_t hpp::manipulation::graph::StateSelector::getWaypointStates ( ) const

Returns a list of all the states.

◆ init()

void hpp::manipulation::graph::StateSelector::init ( const StateSelectorPtr_t weak)
protected

Initialization of the object.

◆ name()

const std::string& hpp::manipulation::graph::StateSelector::name ( ) const
inline

◆ parentGraph() [1/2]

void hpp::manipulation::graph::StateSelector::parentGraph ( const GraphWkPtr_t &  parent)

Set the parent graph.

◆ parentGraph() [2/2]

GraphPtr_t hpp::manipulation::graph::StateSelector::parentGraph ( ) const

Set the parent graph.

◆ print()

virtual std::ostream& hpp::manipulation::graph::StateSelector::print ( std::ostream &  os) const
protectedvirtual

Print the object in a stream.

Reimplemented in hpp::manipulation::graph::GuidedStateSelector.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const StateSelector ss 
)
friend

Member Data Documentation

◆ orderedStates_

WeighedStates_t hpp::manipulation::graph::StateSelector::orderedStates_
protected

◆ waypoints_

States_t hpp::manipulation::graph::StateSelector::waypoints_
protected

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