xal.extension.solver

Class AlgorithmRunStack

java.lang.Object

xal.extension.solver.AlgorithmRunStack

public class AlgorithmRunStack
extends java.lang.Object

AlgorithmRunStack is a container of algorithm runs and represents a single starategy's run requests.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.LinkedList<AlgorithmRun>	_runs the list of runs
protected AlgorithmStrategy	_strategy the algorithm strategy that populated the run stack

Constructor Summary

Constructors

Constructor and Description
AlgorithmRunStack() Constructor
AlgorithmRunStack(AlgorithmRun run) Constructor
AlgorithmRunStack(AlgorithmStrategy strategy) Primary Constructor

Method Summary

Modifier and Type	Method and Description
void	appendRun(AlgorithmRun anAlgorithmRun) Add another another algorithm run to the stack.
void	appendStack(AlgorithmRunStack anAlgorithmRunStack) Add another algorithm run stack to the stack.
java.util.List<AlgorithmRun>	getAlgorithmRuns() Get the algorithm runs.
AlgorithmStrategy	getAlgorithmStrategy() Get the algorithm strategy that populated this algorithm run stack.
boolean	hasNext() Determine if there are any more algorithm runs in the algorithm run stack.
AlgorithmRun	popAlgorithmRun() Get the next algorithm to be run.
void	reset() Reset the algorithm schedule.

Methods inherited from class java.lang.Object

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

Field Detail

_strategy

protected AlgorithmStrategy _strategy

the algorithm strategy that populated the run stack

_runs

protected java.util.LinkedList<AlgorithmRun> _runs

the list of runs

Constructor Detail

AlgorithmRunStack

public AlgorithmRunStack(AlgorithmStrategy strategy)

Primary Constructor

AlgorithmRunStack

public AlgorithmRunStack()

Constructor

AlgorithmRunStack

public AlgorithmRunStack(AlgorithmRun run)

Constructor

Parameters:

run - the run with which to initialize the run stack

Method Detail

reset

public void reset()

Reset the algorithm schedule.

hasNext

public boolean hasNext()

Determine if there are any more algorithm runs in the algorithm run stack.

Returns:

True if there are more algorithm runs.

appendStack

public void appendStack(AlgorithmRunStack anAlgorithmRunStack)

Add another algorithm run stack to the stack.

Parameters:

anAlgorithmRunStack - The algorithm to add to the stack.

appendRun

public void appendRun(AlgorithmRun anAlgorithmRun)

Add another another algorithm run to the stack.

Parameters:

anAlgorithmRun - The algorithm to add to the stack.

getAlgorithmRuns

public java.util.List<AlgorithmRun> getAlgorithmRuns()

Get the algorithm runs.

Returns:

The list of algorithm runs.

getAlgorithmStrategy

public AlgorithmStrategy getAlgorithmStrategy()

Get the algorithm strategy that populated this algorithm run stack.

Returns:

the algorithm strategy that populated this instance

popAlgorithmRun

public AlgorithmRun popAlgorithmRun()

Get the next algorithm to be run.

Returns:

A search algorithm.