hpp::core::Node Class Reference

#include <hpp/core/node.hh>

Public Types
typedef std::list< EdgePtr_t >	Edges_t

Public Member Functions
	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)
	Store the connected component the node belongs to. More...
ConnectedComponentPtr_t	connectedComponent () const
const Edges_t &	outEdges () const
	Access to outEdges. More...
const Edges_t &	inEdges () const
	Access to inEdges. More...
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
	Print node in a stream. More...
virtual	~Node ()

Detailed Description

Node of a roadmap

Stores a configuration.

Member Typedef Documentation

Edges_t

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

Constructor & Destructor Documentation

Node() [1/2]

hpp::core::Node::Node

(

const ConfigurationPtr_t &

configuration

)

Constructor

Parameters

configuration

configuration stored in the new node

Note

A new connected component is created. For consistency, the new node is not registered in the connected component.

Node() [2/2]

hpp::core::Node::Node	(	const ConfigurationPtr_t &	configuration,
		ConnectedComponentPtr_t	connectedComponent
	)

Constructor

Parameters

configuration	configuration stored in the new node
connectedComponent	connected component the node belongs to.

~Node()

virtual hpp::core::Node::~Node ( )

inlinevirtual

Member Function Documentation

addInEdge()

void hpp::core::Node::addInEdge

(

EdgePtr_t

edge

)

addOutEdge()

void hpp::core::Node::addOutEdge

(

EdgePtr_t

edge

)

configuration()

ConfigurationPtr_t hpp::core::Node::configuration

(

)

const

connectedComponent() [1/2]

void hpp::core::Node::connectedComponent

(

const ConnectedComponentPtr_t &

cc

)

Store the connected component the node belongs to.

connectedComponent() [2/2]

ConnectedComponentPtr_t hpp::core::Node::connectedComponent

(

)

const

inEdges()

const Edges_t& hpp::core::Node::inEdges

(

)

const

Access to inEdges.

isInNeighbor()

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.

isOutNeighbor()

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.

outEdges()

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

(

)

const

Access to outEdges.

print()

std::ostream& hpp::core::Node::print

(

std::ostream &

os

)

const

Print node in a stream.

---

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

• include/hpp/core/node.hh