energygroup.sequentialNetworks

Class CalculationGraph<T>

java.lang.Object

edu.uci.ics.jung.graph.AbstractGraph<V,E>

edu.uci.ics.jung.graph.SparseGraph<CalculationStepNode<T>,CalculationTransition<T>>

energygroup.sequentialNetworks.CalculationGraph<T>

Type Parameters:

T - the actual type that describes the intermediate data model between two CalculationStepNodes

All Implemented Interfaces:

edu.uci.ics.jung.graph.Graph<CalculationStepNode<T>,CalculationTransition<T>>, edu.uci.ics.jung.graph.Hypergraph<CalculationStepNode<T>,CalculationTransition<T>>, java.io.Serializable

public class CalculationGraph<T>
extends edu.uci.ics.jung.graph.SparseGraph<CalculationStepNode<T>,CalculationTransition<T>>

The Class CalculationGraph is used to describe the single calculation steps for a sequential network calculation and consists of CalculationStepNodes and CalculationTransitions.

See Also:

CalculationStepNode, CalculationTransition, AbstractSequentialNetworkCalculation, Serialized Form

Field Summary

Fields inherited from class edu.uci.ics.jung.graph.SparseGraph

directed_edges, INCIDENT, INCOMING, OUTGOING, undirected_edges, vertex_maps

Constructor Summary

Constructors

Constructor and Description
CalculationGraph()

Method Summary

Modifier and Type	Method and Description
CalculationStepNode<T>	addCalculationStepNode(javax.swing.tree.DefaultMutableTreeNode groupTreeNode, java.util.HashMap<javax.swing.tree.DefaultMutableTreeNode,T> inNodeStates, T outNodeState) Creates and adds a CalculationStepNode to the current CalculationGraph.
CalculationTransition<T>	addCalculationTransition(CalculationStepNode<T> nodeFrom, CalculationStepNode<T> nodeTo) Adds and returns a CalculationTransition between the specified CalculationStepNode's.
void	addFinalCalculationStepNode(CalculationStepNode<T> newFinalNode) Adds the specified final CalculationStepNode to this CalculationGraph.
CalculationStepNode<T>	getCalculationStepNode(javax.swing.tree.DefaultMutableTreeNode groupNodeInitial) Gets the calculation step node.
java.util.Vector<CalculationStepNode<T>>	getFinalCalculationStepNodes() Returns the final CalculationStepNode that were visited as end node during a sequential calculation.
CalculationStepNode<T>	getInitialCalculationStepNode() Gets the initial calculation step node.
void	resetNodeStates() Resets all in- and out-node states.
void	setFinalCalculationStepNode(java.util.Vector<CalculationStepNode<T>> finalCalculationStepNodes) Sets the final calculation step node.
void	setInitialCalculationStepNode(CalculationStepNode<T> initialCalculationStepNode) Sets the initial calculation step node.
CalcGraphFrame<T>	showVisualisation() Shows the visualisation of the current CalculationGraph.

Methods inherited from class edu.uci.ics.jung.graph.SparseGraph

addEdge, addVertex, containsEdge, containsVertex, findEdge, findEdgeSet, getDefaultEdgeType, getDest, getEdgeCount, getEdgeCount, getEdges, getEdges, getEdgeType, getEndpoints, getFactory, getIncidentEdges, getInEdges, getNeighbors, getOutEdges, getPredecessors, getSource, getSuccessors, getVertexCount, getVertices, isDest, isSource, removeEdge, removeVertex

Methods inherited from class edu.uci.ics.jung.graph.AbstractGraph

addEdge, addEdge, addEdge, addEdge, addEdge, degree, getIncidentCount, getIncidentVertices, getNeighborCount, getOpposite, getPredecessorCount, getSuccessorCount, getValidatedEndpoints, inDegree, isIncident, isNeighbor, isPredecessor, isSuccessor, outDegree, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.uci.ics.jung.graph.Graph

addEdge, addEdge, getOpposite, getPredecessorCount, getSuccessorCount, inDegree, isPredecessor, isSuccessor, outDegree

Methods inherited from interface edu.uci.ics.jung.graph.Hypergraph

addEdge, addEdge, degree, getIncidentCount, getIncidentVertices, getNeighborCount, isIncident, isNeighbor

Constructor Detail

CalculationGraph

public CalculationGraph()

Method Detail

addCalculationStepNode

public CalculationStepNode<T> addCalculationStepNode(javax.swing.tree.DefaultMutableTreeNode groupTreeNode,
                                                     java.util.HashMap<javax.swing.tree.DefaultMutableTreeNode,T> inNodeStates,
                                                     T outNodeState)

Creates and adds a CalculationStepNode to the current CalculationGraph.

Parameters:

groupTreeNode - the group tree node from the GroupTreeModel

inNodeStates - the in node states

outNodeState - the out node state

Returns:

the newly created CalculationStepNode

addCalculationTransition

public CalculationTransition<T> addCalculationTransition(CalculationStepNode<T> nodeFrom,
                                                         CalculationStepNode<T> nodeTo)

Adds and returns a CalculationTransition between the specified CalculationStepNode's.

Parameters:

nodeFrom - the node from which the data have to be taken

nodeTo - the node which the data has to be transfered

Returns:

the calculation transition

getCalculationStepNode

public CalculationStepNode<T> getCalculationStepNode(javax.swing.tree.DefaultMutableTreeNode groupNodeInitial)

Gets the calculation step node.

Parameters:

groupNodeInitial - the group node initial

Returns:

the calculation step node

resetNodeStates

public void resetNodeStates()

Resets all in- and out-node states.

getInitialCalculationStepNode

public CalculationStepNode<T> getInitialCalculationStepNode()

Gets the initial calculation step node.

Returns:

the initial calculation step node

setInitialCalculationStepNode

public void setInitialCalculationStepNode(CalculationStepNode<T> initialCalculationStepNode)

Sets the initial calculation step node.

Parameters:

initialCalculationStepNode - the new initial calculation step node

getFinalCalculationStepNodes

public java.util.Vector<CalculationStepNode<T>> getFinalCalculationStepNodes()

Returns the final CalculationStepNode that were visited as end node during a sequential calculation.

Returns:

the vector of final nodes

setFinalCalculationStepNode

public void setFinalCalculationStepNode(java.util.Vector<CalculationStepNode<T>> finalCalculationStepNodes)

Sets the final calculation step node.

Parameters:

finalCalculationStepNodes - the new final calculation step node

addFinalCalculationStepNode

public void addFinalCalculationStepNode(CalculationStepNode<T> newFinalNode)

Adds the specified final CalculationStepNode to this CalculationGraph.

Parameters:

newFinalNode - the new final node

showVisualisation

public CalcGraphFrame<T> showVisualisation()

Shows the visualisation of the current CalculationGraph.