hpp-manipulation  4.9.0
Classes for manipulation planning.
hpp::manipulation::RoadmapNode Class Reference

#include <hpp/manipulation/roadmap-node.hh>

Inheritance diagram for hpp::manipulation::RoadmapNode:
Collaboration diagram for hpp::manipulation::RoadmapNode:

Public Member Functions

 RoadmapNode (const ConfigurationPtr_t &configuration)
 
 RoadmapNode (const ConfigurationPtr_t &configuration, ConnectedComponentPtr_t cc)
 
void leafConnectedComponent (const LeafConnectedCompPtr_t &sc)
 
LeafConnectedCompPtr_t leafConnectedComponent () const
 
- Public Member Functions inherited from hpp::core::Node
 Node (const ConfigurationPtr_t &configuration)
 
 Node (const ConfigurationPtr_t &configuration, ConnectedComponentPtr_t connectedComponent)
 
void addOutEdge (EdgePtr_t edge)
 
void addInEdge (EdgePtr_t edge)
 
void connectedComponent (const ConnectedComponentPtr_t &cc)
 
ConnectedComponentPtr_t connectedComponent () const
 
const Edges_toutEdges () const
 
const Edges_tinEdges () const
 
bool isOutNeighbor (const NodePtr_t &n) const
 
bool isInNeighbor (const NodePtr_t &n) const
 
ConfigurationPtr_t configuration () const
 
std::ostream & print (std::ostream &os) const
 
virtual ~Node ()
 
 Node (const ConfigurationPtr_t &configuration)
 
 Node (const ConfigurationPtr_t &configuration, ConnectedComponentPtr_t connectedComponent)
 
void addOutEdge (EdgePtr_t edge)
 
void addInEdge (EdgePtr_t edge)
 
void connectedComponent (const ConnectedComponentPtr_t &cc)
 
ConnectedComponentPtr_t connectedComponent () const
 
const Edges_toutEdges () const
 
const Edges_tinEdges () const
 
bool isOutNeighbor (const NodePtr_t &n) const
 
bool isInNeighbor (const NodePtr_t &n) const
 
ConfigurationPtr_t configuration () const
 
std::ostream & print (std::ostream &os) const
 
virtual ~Node ()
 

Cache system

enum  CachingSystem { CACHE_DISABLED, CACHE_UP_TO_DATE, CACHE_NEED_UPDATE }
 
static CachingSystem defaultCachingSystem
 
CachingSystem cachingSystem () const
 Get the caching system being used. More...
 
graph::StatePtr_t graphNode () const HPP_MANIPULATION_DEPRECATED
 
graph::StatePtr_t graphState () const
 Getter for the graph::State. More...
 
void graphNode (const graph::StatePtr_t &state) HPP_MANIPULATION_DEPRECATED
 
void graphState (const graph::StatePtr_t &state)
 Setter for the graph::State. More...
 

Additional Inherited Members

- Public Types inherited from hpp::core::Node
typedef std::list< EdgePtr_tEdges_t
 
typedef std::list< EdgePtr_tEdges_t
 

Member Enumeration Documentation

◆ CachingSystem

Enumerator
CACHE_DISABLED 

The caching system is disabled. The graph::Node containing this node can be obtained by checking the constraints.

CACHE_UP_TO_DATE 

The chaching system is enabled and up to date.

CACHE_NEED_UPDATE 

The chaching system is enabled but the cache is not up to date.

Constructor & Destructor Documentation

◆ RoadmapNode() [1/2]

hpp::manipulation::RoadmapNode::RoadmapNode ( const ConfigurationPtr_t configuration)
inline

◆ RoadmapNode() [2/2]

hpp::manipulation::RoadmapNode::RoadmapNode ( const ConfigurationPtr_t configuration,
ConnectedComponentPtr_t  cc 
)

Member Function Documentation

◆ cachingSystem()

CachingSystem hpp::manipulation::RoadmapNode::cachingSystem ( ) const
inline

Get the caching system being used.

◆ graphNode() [1/2]

graph::StatePtr_t hpp::manipulation::RoadmapNode::graphNode ( ) const
inline

Getter for the graph::State.

Deprecated:
use graphState instead.

◆ graphNode() [2/2]

void hpp::manipulation::RoadmapNode::graphNode ( const graph::StatePtr_t state)
inline

Setter for the graph::State.

Deprecated:
use graphState instead

◆ graphState() [1/2]

graph::StatePtr_t hpp::manipulation::RoadmapNode::graphState ( ) const
inline

Getter for the graph::State.

◆ graphState() [2/2]

void hpp::manipulation::RoadmapNode::graphState ( const graph::StatePtr_t state)
inline

Setter for the graph::State.

◆ leafConnectedComponent() [1/2]

void hpp::manipulation::RoadmapNode::leafConnectedComponent ( const LeafConnectedCompPtr_t sc)
inline

◆ leafConnectedComponent() [2/2]

LeafConnectedCompPtr_t hpp::manipulation::RoadmapNode::leafConnectedComponent ( ) const
inline

Member Data Documentation

◆ defaultCachingSystem

CachingSystem hpp::manipulation::RoadmapNode::defaultCachingSystem
static

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