ilog.views.graphlayout.topologicalmesh

Class IlvTopologicalMeshLayoutReport

java.lang.Object

ilog.views.graphlayout.IlvGraphLayoutReport

ilog.views.graphlayout.topologicalmesh.IlvTopologicalMeshLayoutReport

All Implemented Interfaces:

Serializable

public class IlvTopologicalMeshLayoutReport
extends IlvGraphLayoutReport

The class used to store information about the behavior of the Topological Mesh Layout algorithm.

Since:

JViews 2.0

See Also:

IlvGraphLayout.performLayout(), Serialized Form

Field Summary

Fields inherited from class ilog.views.graphlayout.IlvGraphLayoutReport

EMPTY_GRAPHER, EXCEPTION_DURING_LAYOUT, GREATEST_CODE, INITIAL_CODE, LAYOUT_DONE, LAYOUT_FINISHED, LAYOUT_STARTED, NO_MOVEABLE_NODE, NO_RESHAPEABLE_LINK, NOT_NEEDED, STOPPED_AND_INVALID, STOPPED_AND_VALID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IlvTopologicalMeshLayoutReport() Creates a new instance of the report object.

Method Summary

Modifier and Type	Method and Description
int	getCurrentBestCost() Returns the current best value of the heuristic cost function of the topological optimization.
int	getCurrentCost() Returns the current value of the heuristic cost function of the topological optimization.
int	getFinalCost() Returns the final value of the heuristic cost function of the topological optimization.
int	getInitialCost() Returns the value of the heuristic cost function at the beginning of the topological optimization.
long	getNodesPlacementTime() Returns the duration of the second step of the layout algorithm (the nodes placement step).
int	getNumberOfNodesPlacementIterations() Returns the number of iterations performed by the nodes placement algorithm.
int	getNumberOfOptimizationIterations() Returns the number of iterations performed by the topological optimization algorithm.
long	getOptimizationTime() Returns the duration of the first step of the layout algorithm (the topological optimization step).

Methods inherited from class ilog.views.graphlayout.IlvGraphLayoutReport

codeToString, codeToString, getCode, getLayoutTime, getPercentageComplete, setCode

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvTopologicalMeshLayoutReport

protected IlvTopologicalMeshLayoutReport()

Creates a new instance of the report object.

Method Detail

getOptimizationTime

public long getOptimizationTime()

Returns the duration of the first step of the layout algorithm (the topological optimization step).

getNodesPlacementTime

public long getNodesPlacementTime()

Returns the duration of the second step of the layout algorithm (the nodes placement step).

getNumberOfOptimizationIterations

public int getNumberOfOptimizationIterations()

Returns the number of iterations performed by the topological optimization algorithm.

getNumberOfNodesPlacementIterations

public int getNumberOfNodesPlacementIterations()

Returns the number of iterations performed by the nodes placement algorithm.

getInitialCost

public int getInitialCost()

Returns the value of the heuristic cost function at the beginning of the topological optimization.
The cost function is a heuristic estimation of the number of edge crossings (assuming the layout is performed using the current topological solution). The smaller this value is the fewer the edge crossings obtained. The value zero corresponds to a solution allowing a drawing of the graph without edge crossings.

getCurrentCost

public int getCurrentCost()

Returns the current value of the heuristic cost function of the topological optimization. The cost function is a heuristic estimation of the number of edge crossings (assuming the layout is performed using the current topological solution). The smaller this value is the fewer the edge crossings obtained. The value zero corresponds to a solution allowing a drawing of the graph without edge crossings.

getFinalCost

public int getFinalCost()

Returns the final value of the heuristic cost function of the topological optimization. The cost function is a heuristic estimation of the number of edge crossings (assuming the layout is performed using the current topological solution). The smaller this value is the fewer the edge crossings obtained. The value zero corresponds to a solution allowing a drawing of the graph without edge crossings.

getCurrentBestCost

public int getCurrentBestCost()

Returns the current best value of the heuristic cost function of the topological optimization. The cost function is a heuristic estimation of the number of edge crossings (assuming the layout is performed using the current topological solution). The smaller this value is the fewer the edge crossings obtained. The value zero corresponds to a solution allowing a drawing of the graph without edge crossings.