Package repast.simphony.engine.graph

Class GraphParams<E>

java.lang.Object

repast.simphony.engine.graph.GraphParams<E>

public class GraphParams<E>
extends Object

An object used to hold parameters for use when executing graphs.

Version:

$Revision: 1.1 $ $Date: 2005/12/21 22:25:34 $

Author:

Jerry Vos

See Also:

Traverser, GraphExecutor.validateForExecution(GraphParams)

Constructor Summary

Constructors

Constructor	Description
GraphParams(E previousNode, E curNode, double previousDistance)	Constructs this GraphParams object holding the specified values.

Method Summary

Modifier and Type	Method	Description
E	getCurrentNode()	Retrieves the current node in the graph execution.
double	getPreviousDistance()	Retrieves the sum of the previous distances in the graph execution.
E	getPreviousNode()	Retrieves the previous node in the graph execution.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GraphParams

public GraphParams(E previousNode,
                   E curNode,
                   double previousDistance)

Constructs this GraphParams object holding the specified values.

Parameters:

previousNode - the previous node

currentNode - the current node

previousDistance - the previous distance that has been traversed

Method Detail

getCurrentNode

public E getCurrentNode()

Retrieves the current node in the graph execution.

Returns:

the current node in the graph execution

getPreviousNode

public E getPreviousNode()

Retrieves the previous node in the graph execution.

Returns:

the previous node in the graph execution

getPreviousDistance

public double getPreviousDistance()

Retrieves the sum of the previous distances in the graph execution.

Returns:

the sum of the previous distances in the graph execution