hpp::core::Node Class Reference

Node of a roadmap. More...

#include <hpp/core/node.hh>

Public Types

typedef std::list< EdgePtr_tEdges_t
 

Public Member Functions

 Node (const ConfigurationPtr_t &configuration)
 Constructor. More...
 
 Node (const ConfigurationPtr_t &configuration, ConnectedComponentPtr_t connectedComponent)
 Constructor. More...
 
void addOutEdge (EdgePtr_t edge)
 
void addInEdge (EdgePtr_t edge)
 
void connectedComponent (const ConnectedComponentPtr_t &cc)
 Store the connected component the node belongs to. More...
 
ConnectedComponentPtr_t connectedComponent () const
 
const Edges_toutEdges () const
 Access to outEdges. More...
 
const Edges_tinEdges () const
 Access to inEdges. More...
 
bool isOutNeighbor (const NodePtr_t &n) const
 Check whether otherNode is an out-neighbor of this node. More...
 
bool isInNeighbor (const NodePtr_t &n) const
 Check whether otherNode is an in-neighbor of this node. More...
 
ConfigurationPtr_t configuration () const
 
std::ostream & print (std::ostream &os) const
 Print node in a stream. More...
 
virtual ~Node ()
 

Detailed Description

Node of a roadmap.

Stores a configuration.

Member Typedef Documentation

typedef std::list<EdgePtr_t> hpp::core::Node::Edges_t

Constructor & Destructor Documentation

hpp::core::Node::Node ( const ConfigurationPtr_t configuration)

Constructor.

Parameters
configurationconfiguration stored in the new node
Note
A new connected component is created. For consistency, the new node is not registered in the connected component.
hpp::core::Node::Node ( const ConfigurationPtr_t configuration,
ConnectedComponentPtr_t  connectedComponent 
)

Constructor.

Parameters
configurationconfiguration stored in the new node
connectedComponentconnected component the node belongs to.
virtual hpp::core::Node::~Node ( )
inlinevirtual

Member Function Documentation

void hpp::core::Node::addInEdge ( EdgePtr_t  edge)
void hpp::core::Node::addOutEdge ( EdgePtr_t  edge)
ConfigurationPtr_t hpp::core::Node::configuration ( ) const
void hpp::core::Node::connectedComponent ( const ConnectedComponentPtr_t cc)

Store the connected component the node belongs to.

ConnectedComponentPtr_t hpp::core::Node::connectedComponent ( ) const
const Edges_t& hpp::core::Node::inEdges ( ) const

Access to inEdges.

bool hpp::core::Node::isInNeighbor ( const NodePtr_t n) const

Check whether otherNode is an in-neighbor of this node.

Node B is an in-neighbor of node A if node A has an ingoing edge going to B.

bool hpp::core::Node::isOutNeighbor ( const NodePtr_t n) const

Check whether otherNode is an out-neighbor of this node.

Node B is an out-neighbor of node A if node A has an outgoing edge going to B.

const Edges_t& hpp::core::Node::outEdges ( ) const

Access to outEdges.

std::ostream& hpp::core::Node::print ( std::ostream &  os) const

Print node in a stream.