public class Control
extends java.lang.Object
The Control
allows to pause, stop, and terminate, the optimization
process.
The Optimizer
calls the methods
TerminationException
) or stopped (by the StopException
). By
definition, a StopException
might get thrown only between iterations,
a TerminationException
also within an iteration of the optimization
algorithm. In this context, the optimization algorithm calls
checkpointStop()
between the iterations and checkpoint()
within the iteration.
Modifier and Type | Class and Description |
---|---|
static class |
Control.State
The
Control.State of the control. |
Modifier and Type | Field and Description |
---|---|
protected java.util.Set<ControlListener> |
listeners |
protected Control.State |
state |
Constructor and Description |
---|
Control() |
Modifier and Type | Method and Description |
---|---|
void |
addListener(ControlListener listener)
Adds a
ControlListener . |
void |
checkpoint()
A checkpoint that checks for termination.
|
void |
checkpointStop()
A checkpoint that checks for termination and stop.
|
void |
doPause()
Pauses the optimization.
|
void |
doStart()
Starts the optimization.
|
void |
doStop()
Stops the optimization.
|
void |
doTerminate()
Terminates the optimization.
|
Control.State |
getState()
Returns the state.
|
boolean |
isPaused()
Returns
true if the optimization is paused. |
boolean |
isRunning()
Returns
true if the optimization is running. |
boolean |
isStopped()
Returns
true if the optimization is stopped. |
boolean |
isTerminated()
Returns
true if the optimization is terminated. |
void |
removeListener(ControlListener listener)
Removes a
ControlListener . |
protected void |
setState(Control.State state)
Sets the state and invokes listeners if the state has changed.
|
protected Control.State state
protected final java.util.Set<ControlListener> listeners
public void doStart()
public void doPause()
public void doStop()
public void doTerminate()
public boolean isRunning()
true
if the optimization is running.true
if the optimization is runningpublic boolean isPaused()
true
if the optimization is paused.true
if the optimization is pausedpublic boolean isStopped()
true
if the optimization is stopped.true
if the optimization is stoppedpublic boolean isTerminated()
true
if the optimization is terminated.true
if the optimization is terminatedpublic void checkpoint() throws TerminationException
TerminationException
- if the optimization is terminatedpublic void checkpointStop() throws TerminationException, StopException
TerminationException
- if the optimization is terminatedStopException
- if the optimization is stoppedpublic Control.State getState()
protected void setState(Control.State state)
state
- the desired statepublic void addListener(ControlListener listener)
ControlListener
.listener
- the listener to addremoveListener(org.opt4j.core.optimizer.ControlListener)
public void removeListener(ControlListener listener)
ControlListener
.listener
- the listener to removeaddListener(org.opt4j.core.optimizer.ControlListener)