de.cau.cs.kieler.core.alg
Interface IAlgorithm

All Known Subinterfaces:
ICrossingReducer, ICycleRemover, IEdgeRouter, ILayerAssigner, ILayerwiseEdgePlacer, ILayoutPhase, ILayoutProcessor, INodePlacer, INodewiseEdgePlacer, ISingleLayerCrossingReducer
All Known Implementing Classes:
AbstractAlgorithm, AbstractCrossingMinimizer, AbstractCycleRemover, AbstractForceModel, BalancingLayerAssigner, BalancingNodePlacer, BarycenterCrossingReducer, BasicNodePlacer, BigNodesProcessor, BoxPlacer, BoxSorter, CommentPostprocessor, CommentPreprocessor, ComponentsProcessor, ComponentsProcessor, CompoundCycleProcessor, CompoundDummyEdgeRemover, CompoundGraphRestorer, CompoundSideProcessor, DFSCycleRemover, EadesModel, EdgeAndLayerConstraintEdgeReverser, FruchtermanReingoldModel, GraphConverter, GraphTransformer, GreedyCycleBreaker, GreedyCycleRemover, HierarchicalPortConstraintProcessor, HierarchicalPortDummySizeProcessor, HierarchicalPortOrthogonalEdgeRouter, HierarchicalPortPositionProcessor, HyperedgeDummyMerger, HypernodesProcessor, InLayerConstraintProcessor, InteractiveCrossingMinimizer, InteractiveCrossingReducer, InteractiveCycleBreaker, InteractiveCycleRemover, InteractiveLayerer, InvertedPortProcessor, LayerConstraintProcessor, LayerSweepCrossingMinimizer, LayerSweepCrossingReducer, LinearSegmentsNodePlacer, LongEdgeJoiner, LongEdgeSplitter, LongestPathLayerAssigner, LongestPathLayerer, NetworkSimplexLayerer, NodeMarginCalculator, NorthSouthPortPostprocessor, NorthSouthPortPreprocessor, OrthogonalEdgeRouter, PolylineEdgeRouter, PortListSorter, PortPositionProcessor, PortSideProcessor, RectilinearEdgeRouter, ReversedEdgeRestorer, SelfLoopProcessor, SortingLayerwiseEdgePlacer, SortingNodewiseEdgePlacer, SplineEdgeRouter, SubgraphOrderingProcessor, ToponumLayerwiseEdgePlacer

public interface IAlgorithm

Interface that serves as super-interface for all algorithm interfaces. Contains progress monitors to keep track of the progress of an algorithm run.

See Also:
IKielerProgressMonitor
Rating proposed yellow
(2009-12-11) msp

Method Summary
 void reset()
          Reset the internal state of the algorithm without a progress monitor.
 void reset(IKielerProgressMonitor monitor)
          Reset the internal state and set the progress monitor for the algorithm.
 void setProgressMonitor(IKielerProgressMonitor monitor)
          Set the progress monitor for the algorithm.
 

Method Detail

reset

void reset()
Reset the internal state of the algorithm without a progress monitor.


reset

void reset(IKielerProgressMonitor monitor)
Reset the internal state and set the progress monitor for the algorithm.

Parameters:
monitor - the progress monitor

setProgressMonitor

void setProgressMonitor(IKielerProgressMonitor monitor)
Set the progress monitor for the algorithm. Algorithm implementations should make proper use of the monitor by notifying at least the start and end of their task.

Parameters:
monitor - the progress monitor