Edge Class Reference

#include <Beobot/Edge.H>

Collaboration diagram for Edge:
Collaboration graph
[legend]

List of all members.

Public Member Functions

Constructor, assigment and destructor

 Edge (float cost=1.0F, const std::string label=std::string(""))
 Constructor: generate a blank edge (no end-nodes).
 Edge (rutz::shared_ptr< Node > sourceNode, rutz::shared_ptr< Node > destNode, float cost=1.0F, const std::string label=std::string(""))
 Constructor: generate a directed edge with two nodes.
 ~Edge ()
 Destructor.
float getCost ()
void setCost (float cost)
 set the cost of the edge
rutz::shared_ptr< NodegetSourceNode ()
 get the source node
rutz::shared_ptr< NodegetDestNode ()
 get the destination node
void setSourceNode (rutz::shared_ptr< Node > sourceNode)
 set the source node
void setDestNode (rutz::shared_ptr< Node > destNode)
 set the destination node
std::string getLabel ()
 get the label of the edge

Detailed Description

basic edge in a graph class the label is for display only, not necessary note its directionality is decided by the graph despite the label source and destination node

Definition at line 53 of file Edge.H.


Constructor & Destructor Documentation

Edge::Edge ( float  cost = 1.0F,
const std::string  label = std::string("") 
)

Constructor: generate a blank edge (no end-nodes).

Definition at line 40 of file Edge.C.

Edge::Edge ( rutz::shared_ptr< Node sourceNode,
rutz::shared_ptr< Node destNode,
float  cost = 1.0F,
const std::string  label = std::string("") 
)

Constructor: generate a directed edge with two nodes.

Definition at line 48 of file Edge.C.

Edge::~Edge (  ) 

Destructor.

Definition at line 59 of file Edge.C.


Member Function Documentation

float Edge::getCost (  )  [inline]

cost of traversing the edge default: 1.0

Definition at line 107 of file Edge.H.

rutz::shared_ptr< Node > Edge::getDestNode (  )  [inline]

get the destination node

Definition at line 122 of file Edge.H.

std::string Edge::getLabel (  )  [inline]

get the label of the edge

Definition at line 137 of file Edge.H.

rutz::shared_ptr< Node > Edge::getSourceNode (  )  [inline]

get the source node

Definition at line 117 of file Edge.H.

void Edge::setCost ( float  cost  )  [inline]

set the cost of the edge

Definition at line 112 of file Edge.H.

void Edge::setDestNode ( rutz::shared_ptr< Node destNode  )  [inline]

set the destination node

Definition at line 132 of file Edge.H.

void Edge::setSourceNode ( rutz::shared_ptr< Node sourceNode  )  [inline]

set the source node

Definition at line 127 of file Edge.H.


The documentation for this class was generated from the following files:
Generated on Sun May 8 08:43:20 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3