RAIN.Path.PathEdge Class Reference

Base class for PathEdge representation. Path edges are directed edges with associated costs, used for graph traversal in directed graphs. Path edges have statically defined costs plus an associated Cost function. Edges are always one way. More...

List of all members.

Public Member Functions

 PathEdge (int from, int to, float cost)
 Constructor for a directed edge.
virtual float Cost ()
 Cost function for edge traversal. Calculated value which may differ from static cost.
 PathEdge (BinaryReader reader)
virtual void Save (BinaryWriter writer)

Properties

int From [get, set]
 Node index of the from node.
int To [get, set]
 Node index of the to node.
float StaticCost [get, set]
 Static cost of traversing the edge.

Detailed Description

Base class for PathEdge representation. Path edges are directed edges with associated costs, used for graph traversal in directed graphs. Path edges have statically defined costs plus an associated Cost function. Edges are always one way.


Constructor & Destructor Documentation

RAIN.Path.PathEdge.PathEdge ( int  from,
int  to,
float  cost 
)

Constructor for a directed edge.

Parameters:
fromnode index of the from node
tonode index of the to node
coststatic edge traversal cost

Member Function Documentation

virtual float RAIN.Path.PathEdge.Cost ( ) [virtual]

Cost function for edge traversal. Calculated value which may differ from static cost.

Returns:
Edge traversal cost

Property Documentation

int RAIN.Path.PathEdge.From [get, set]

Node index of the from node.

float RAIN.Path.PathEdge.StaticCost [get, set]

Static cost of traversing the edge.

int RAIN.Path.PathEdge.To [get, set]

Node index of the to node.