Package etomica.action.controller

Class Controller

java.lang.Object

etomica.action.controller.Controller

public class Controller
extends java.lang.Object

The Controller organizes and executes all actions and activities during a running simulation.

A Simulation run consists of one or more Activities performed sequentially. An Activity is a "long-running" task considered to be the driver of the simulation; typically integration with ActivityIntegrate. The Controller facilitates interactive simulations by optionally running Activities on a separate thread and provides an interface to pause, resume, and submit Actions which can modify the simulation in a thread-safe manner. For non-interactive simulation runs, the same Activities can be executed on the current thread with runActivityBlocking.

See Also:

IAction, Activity

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Controller.ActivityHandle<A extends Activity>
static class	Controller.ControllerHandle

Constructor Summary

Constructors

Constructor	Description
Controller()

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<java.lang.Void>	addActionSequential(IAction action)
<A extends Activity> Controller.ActivityHandle<A>	addActivity(A activity)	Adds an Activity to be executed by the Controller on a separate thread.
Controller.ActivityHandle<ActivityIntegrate>	addActivity(ActivityIntegrate activity, long maxSteps)
Controller.ActivityHandle<ActivityIntegrate>	addActivity(ActivityIntegrate activity, long maxSteps, double sleepPeriodMillis)
void	completeActivities()
Integrator	getIntegrator()
double	getSleepPeriod()
void	halt()
boolean	isPaused()
boolean	isRunningActivityStep()
java.util.concurrent.CompletableFuture<java.lang.Void>	pause()
java.util.concurrent.CompletableFuture<java.lang.Void>	restartCurrentActivity()
void	runActivityBlocking(Activity activity)	Runs an activity to completion on the current thread.
void	setSleepPeriod(double sleepPeriodMillis)
void	start()
java.util.concurrent.CompletableFuture<java.lang.Void>	submitActionInterrupt(IAction action)	Submit an Action which will be executed on the Activity thread before its next step.
java.util.concurrent.CompletableFuture<java.lang.Void>	toggle()
java.util.concurrent.CompletableFuture<java.lang.Void>	unpause()

Methods inherited from class java.lang.Object

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

Constructor Detail

Controller

public Controller()

Method Detail

addActivity

public Controller.ActivityHandle<ActivityIntegrate> addActivity(ActivityIntegrate activity,
                                                                long maxSteps)

addActivity

public Controller.ActivityHandle<ActivityIntegrate> addActivity(ActivityIntegrate activity,
                                                                long maxSteps,
                                                                double sleepPeriodMillis)

addActivity

public <A extends Activity> Controller.ActivityHandle<A> addActivity(A activity)

Adds an Activity to be executed by the Controller on a separate thread. Activities will be run in the order they are added, with the next one starting after the current one completes. Activities will not begin execution until the start method has been called. The returned ActivityHandle contains a `CompletableFuture` which will be completed when the activity finishes.

Parameters:

activity -

runActivityBlocking

public void runActivityBlocking(Activity activity)

Runs an activity to completion on the current thread.

Parameters:

activity -

getIntegrator

public Integrator getIntegrator()

start

public void start()

pause

public java.util.concurrent.CompletableFuture<java.lang.Void> pause()

unpause

public java.util.concurrent.CompletableFuture<java.lang.Void> unpause()

toggle

public java.util.concurrent.CompletableFuture<java.lang.Void> toggle()

halt

public void halt()

restartCurrentActivity

public java.util.concurrent.CompletableFuture<java.lang.Void> restartCurrentActivity()

completeActivities

public void completeActivities()

isPaused

public boolean isPaused()

isRunningActivityStep

public boolean isRunningActivityStep()

submitActionInterrupt

public java.util.concurrent.CompletableFuture<java.lang.Void> submitActionInterrupt(IAction action)

Submit an Action which will be executed on the Activity thread before its next step. Since the Action is guaranteed not to run concurrently with the Activity's calculations, any modification of Simulation properties will be free of data races.

Parameters:

action -

Returns:

addActionSequential

public java.util.concurrent.CompletableFuture<java.lang.Void> addActionSequential(IAction action)

getSleepPeriod

public double getSleepPeriod()

setSleepPeriod

public void setSleepPeriod(double sleepPeriodMillis)