Package jasima.core.simulation

Class SimContext

java.lang.Object

jasima.core.simulation.SimContext

public class SimContext
extends Object

SimContext provides static versions of the most frequently used simulation methods as well as static factory methods to create new simulations. By statically importing the methods from SimContext, the most important simulation methods can be accessed in a more concise way or in contexts, where the current simulation can not be accessed easily.

The currently active simulation is stored internally in a ThreadLocal variable. Most methods in this class call requireSimContext() and then delegate to the corresponding method in Simulation or the simulation's currently active SimProcess. Exceptions to this are the factory methods simulationOf(String, SimAction)/ async(String, SimAction)/ createSim(String, SimAction).

Author:

Torsten.Hildebrandt

Constructor Summary

Constructors

Constructor	Description
SimContext()

Method Summary

Modifier and Type	Method	Description
static SimProcess<Void>	activate(SimProcessUtil.SimAction a)	ProcessActivator.activate(SimAction)
static SimProcess<Void>	activate(SimProcessUtil.SimRunnable r)	ProcessActivator.activate(SimRunnable)
static SimProcess<Void>	activate(String name, SimProcessUtil.SimAction a)	ProcessActivator.activate(String, SimAction)
static SimProcess<Void>	activate(String name, SimProcessUtil.SimRunnable r)	ProcessActivator.activate(String,SimRunnable)
static <T> SimProcess<T>	activateCallable(SimProcessUtil.SimCallable<T> a)	ProcessActivator.activateCallable(SimCallable)
static <T> SimProcess<T>	activateCallable(String name, SimProcessUtil.SimCallable<T> a)	ProcessActivator.activateCallable(String, SimCallable)
static <T> SimProcess<T>	activateCallable(String name, Callable<T> c)	ProcessActivator.activateCallable(String, Callable)
static <T> SimProcess<T>	activateCallable(Callable<T> c)	ProcessActivator.activateCallable(Callable)
static SimProcess<Void>	activateEntity(SimEntity e)	Activates the given SimEntity and returns its lifecycle process Simulation.activateEntity(SimEntity).
static void	addResult(String name, Object value)
static Future<Map<String,Object>>	async(SimProcessUtil.SimAction a)
static Future<Map<String,Object>>	async(SimProcessUtil.SimRunnable r)
static Future<Map<String,Object>>	async(String name, SimProcessUtil.SimAction a)	Create a new simulation and run it asynchronously in a background thread.
static Future<Map<String,Object>>	async(String name, SimProcessUtil.SimRunnable r)
static Simulation	createSim(String name, SimProcessUtil.SimAction a)	Create a new simulation, but does not yet execute it.
static SimProcess<?>	currentProcess()	Simulation.currentProcess()
static Simulation	currentSimulation()	Returns the current Simulation or null if no simulation is currently assigned to the current thread.
static void	end()
static String	formattedMessage(Enum<?> key, Object... params)	Simulation#formattedMessage(Enum, Object)
static <T extends DblSequence> T	initRndGen(T s, String streamName)
static String	message(Enum<?> key)	Simulation.message(Enum)
static String	message(String keyName)	Simulation.message(String)
static Simulation	requireSimContext()	Returns the current Simulation.
static SimEvent	schedule(SimEvent event)
static SimEvent	scheduleAt(double time, int prio, Runnable method)
static SimEvent	scheduleAt(double time, Runnable method)
static SimEvent	scheduleAt(String description, double time, int prio, Runnable action)
static SimEvent	scheduleAt(String description, double time, Runnable action)
static SimEvent	scheduleAt(String description, Instant time, int prio, Runnable method)
static SimEvent	scheduleAt(String description, Instant time, Runnable method)
static SimEvent	scheduleAt(Instant time, int prio, Runnable method)
static SimEvent	scheduleAt(Instant time, Runnable method)
static SimEvent	scheduleIn(double time, int prio, Runnable method)
static SimEvent	scheduleIn(double time, Runnable method)
static SimEvent	scheduleIn(long numUnits, TemporalUnit unit, int prio, Runnable method)
static SimEvent	scheduleIn(long numUnits, TemporalUnit unit, Runnable method)
static SimEvent	scheduleIn(String description, double time, int prio, Runnable method)
static SimEvent	scheduleIn(String description, double time, Runnable method)
static SimEvent	scheduleIn(String description, long numUnits, TemporalUnit unit, int prio, Runnable method)
static SimEvent	scheduleIn(String description, long numUnits, TemporalUnit unit, Runnable method)
static SimEvent	scheduleIn(String description, Duration duration, int prio, Runnable method)
static SimEvent	scheduleIn(String description, Duration duration, Runnable method)
static SimEvent	scheduleIn(Duration duration, int prio, Runnable method)
static SimEvent	scheduleIn(Duration duration, Runnable method)
static double	simTime()	Simulation.simTime()
static Map<String,Object>	simulationOf(SimComponent... components)
static Map<String,Object>	simulationOf(SimProcessUtil.SimAction a)
static Map<String,Object>	simulationOf(SimProcessUtil.SimRunnable r)
static Map<String,Object>	simulationOf(String name, SimComponent... components)
static Map<String,Object>	simulationOf(String name, SimProcessUtil.SimAction a)	Create a new simulation and immediately executes it.
static Map<String,Object>	simulationOf(String name, SimProcessUtil.SimRunnable r)
static void	suspend()
static double	toSimTime(long amount, TemporalUnit u)	Simulation.toSimTime(long, TemporalUnit)
static double	toSimTime(Duration d)	Simulation.toSimTime(Duration)
static void	trace(Object... params)
static boolean	waitCondition(ObservableValue<Boolean> triggerCondition)
static <T1,T2> boolean	waitCondition(BiFunction<T1,T2,Boolean> triggerCondition, ObservableValue<? extends T1> obs1, ObservableValue<? extends T2> obs2)
static <T> boolean	waitCondition(Function<T,Boolean> triggerCondition, ObservableValue<? extends T> observable)
static void	waitFor(double deltaT)	SimProcess.waitFor(double)
static void	waitFor(long amount, TemporalUnit u)	SimProcess.waitFor(long,TemporalUnit)
static void	waitFor(Duration d)	SimProcess.waitFor(Duration)
static void	waitUntil(double tAbs)	SimProcess.waitUntil(double)
static void	waitUntil(Instant instant)	SimProcess.waitUntil(Instant)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimContext

public SimContext()

Method Detail

currentSimulation

@Nullable
public static Simulation currentSimulation()

Returns the current Simulation or null if no simulation is currently assigned to the current thread.

requireSimContext

public static Simulation requireSimContext()

Returns the current Simulation. If there is no simulation, an IllegalStateException is thrown.

currentProcess

public static SimProcess<?> currentProcess()

Simulation.currentProcess()

simTime

public static double simTime()

Simulation.simTime()

toSimTime

public static double toSimTime(long amount,
                               TemporalUnit u)

Simulation.toSimTime(long, TemporalUnit)

toSimTime

public static double toSimTime(Duration d)

Simulation.toSimTime(Duration)

message

public static String message(Enum<?> key)

Simulation.message(Enum)

message

public static String message(String keyName)

Simulation.message(String)

formattedMessage

public static String formattedMessage(Enum<?> key,
                                      Object... params)

Simulation#formattedMessage(Enum, Object)

activateEntity

public static SimProcess<Void> activateEntity(SimEntity e)

Activates the given SimEntity and returns its lifecycle process Simulation.activateEntity(SimEntity).

activate

public static SimProcess<Void> activate(SimProcessUtil.SimRunnable r)

ProcessActivator.activate(SimRunnable)

activate

public static SimProcess<Void> activate(String name,
                                        SimProcessUtil.SimRunnable r)

ProcessActivator.activate(String,SimRunnable)

activate

public static SimProcess<Void> activate(SimProcessUtil.SimAction a)

ProcessActivator.activate(SimAction)

activate

public static SimProcess<Void> activate(String name,
                                        SimProcessUtil.SimAction a)

ProcessActivator.activate(String, SimAction)

activateCallable

public static <T> SimProcess<T> activateCallable(Callable<T> c)

ProcessActivator.activateCallable(Callable)

activateCallable

public static <T> SimProcess<T> activateCallable(String name,
                                                 Callable<T> c)

ProcessActivator.activateCallable(String, Callable)

activateCallable

public static <T> SimProcess<T> activateCallable(SimProcessUtil.SimCallable<T> a)

ProcessActivator.activateCallable(SimCallable)

activateCallable

public static <T> SimProcess<T> activateCallable(String name,
                                                 SimProcessUtil.SimCallable<T> a)

ProcessActivator.activateCallable(String, SimCallable)

trace

public static void trace(Object... params)

See Also:

Simulation.trace(Object...)

end

public static void end()

See Also:

Simulation.end()

addResult

public static void addResult(String name,
                             Object value)

See Also:

Simulation.addResult(String, Object)

waitFor

public static void waitFor(double deltaT)
                    throws SimProcess.MightBlock

SimProcess.waitFor(double)

Throws:

SimProcess.MightBlock

waitFor

public static void waitFor(long amount,
                           TemporalUnit u)
                    throws SimProcess.MightBlock

SimProcess.waitFor(long,TemporalUnit)

Throws:

SimProcess.MightBlock

waitFor

public static void waitFor(Duration d)
                    throws SimProcess.MightBlock

SimProcess.waitFor(Duration)

Throws:

SimProcess.MightBlock

waitUntil

public static void waitUntil(double tAbs)
                      throws SimProcess.MightBlock

SimProcess.waitUntil(double)

Throws:

SimProcess.MightBlock

waitUntil

public static void waitUntil(Instant instant)
                      throws SimProcess.MightBlock

SimProcess.waitUntil(Instant)

Throws:

SimProcess.MightBlock

waitCondition

public static boolean waitCondition(ObservableValue<Boolean> triggerCondition)
                             throws SimProcess.MightBlock

Throws:

SimProcess.MightBlock

See Also:

SimProcess.waitCondition(ObservableValue)

waitCondition

public static <T> boolean waitCondition(Function<T,Boolean> triggerCondition,
                                        ObservableValue<? extends T> observable)
                                 throws SimProcess.MightBlock

Throws:

SimProcess.MightBlock

See Also:

SimProcess.waitCondition(Function, ObservableValue)

waitCondition

public static <T1,T2> boolean waitCondition(BiFunction<T1,T2,Boolean> triggerCondition,
                                                  ObservableValue<? extends T1> obs1,
                                                  ObservableValue<? extends T2> obs2)
                                           throws SimProcess.MightBlock

Throws:

SimProcess.MightBlock

See Also:

SimProcess.waitCondition(BiFunction, ObservableValue, ObservableValue)

suspend

public static void suspend()
                    throws SimProcess.MightBlock

Throws:

SimProcess.MightBlock

See Also:

SimProcess.suspend()

schedule

public static SimEvent schedule(SimEvent event)

See Also:

Simulation.schedule(SimEvent)

scheduleAt

public static SimEvent scheduleAt(double time,
                                  int prio,
                                  Runnable method)

See Also:

SimOperations.scheduleAt(double, int, Runnable)

scheduleAt

public static SimEvent scheduleAt(double time,
                                  Runnable method)

See Also:

SimOperations.scheduleAt(double, Runnable)

scheduleAt

public static SimEvent scheduleAt(String description,
                                  double time,
                                  int prio,
                                  Runnable action)

See Also:

SimOperations.scheduleAt(String, double, int, Runnable)

scheduleAt

public static SimEvent scheduleAt(String description,
                                  double time,
                                  Runnable action)

See Also:

SimOperations.scheduleAt(String, double, Runnable)

scheduleAt

public static SimEvent scheduleAt(Instant time,
                                  int prio,
                                  Runnable method)

See Also:

SimOperations.scheduleAt(Instant, int, Runnable)

scheduleAt

public static SimEvent scheduleAt(Instant time,
                                  Runnable method)

See Also:

SimOperations.scheduleAt(Instant, int, Runnable)

scheduleAt

public static SimEvent scheduleAt(String description,
                                  Instant time,
                                  int prio,
                                  Runnable method)

See Also:

SimOperations.scheduleAt(String, Instant, int, Runnable)

scheduleAt

public static SimEvent scheduleAt(String description,
                                  Instant time,
                                  Runnable method)

See Also:

SimOperations.scheduleAt(String, Instant, Runnable)

scheduleIn

public static SimEvent scheduleIn(double time,
                                  int prio,
                                  Runnable method)

See Also:

SimOperations.scheduleIn(double, int, Runnable)

scheduleIn

public static SimEvent scheduleIn(double time,
                                  Runnable method)

See Also:

SimOperations.scheduleIn(double, Runnable)

scheduleIn

public static SimEvent scheduleIn(String description,
                                  double time,
                                  int prio,
                                  Runnable method)

See Also:

SimOperations.scheduleIn(String, double, int, Runnable)

scheduleIn

public static SimEvent scheduleIn(String description,
                                  double time,
                                  Runnable method)

See Also:

SimOperations.scheduleIn(String, double, Runnable)

scheduleIn

public static SimEvent scheduleIn(Duration duration,
                                  int prio,
                                  Runnable method)

See Also:

SimOperations.scheduleIn(Duration, int, Runnable)

scheduleIn

public static SimEvent scheduleIn(Duration duration,
                                  Runnable method)

See Also:

SimOperations.scheduleIn(Duration, Runnable)

scheduleIn

public static SimEvent scheduleIn(String description,
                                  Duration duration,
                                  int prio,
                                  Runnable method)

See Also:

SimOperations.scheduleIn(String, Duration, int, Runnable)

scheduleIn

public static SimEvent scheduleIn(String description,
                                  Duration duration,
                                  Runnable method)

See Also:

SimOperations.scheduleIn(String, Duration, Runnable)

scheduleIn

public static SimEvent scheduleIn(long numUnits,
                                  TemporalUnit unit,
                                  int prio,
                                  Runnable method)

See Also:

SimOperations.scheduleIn(long, TemporalUnit, int, Runnable)

scheduleIn

public static SimEvent scheduleIn(long numUnits,
                                  TemporalUnit unit,
                                  Runnable method)

See Also:

SimOperations.scheduleIn(long, TemporalUnit, Runnable)

scheduleIn

public static SimEvent scheduleIn(String description,
                                  long numUnits,
                                  TemporalUnit unit,
                                  int prio,
                                  Runnable method)

See Also:

SimOperations.scheduleIn(String, long, TemporalUnit, int, Runnable)

scheduleIn

public static SimEvent scheduleIn(String description,
                                  long numUnits,
                                  TemporalUnit unit,
                                  Runnable method)

See Also:

SimOperations.scheduleIn(String, long, TemporalUnit, Runnable)

initRndGen

public static <T extends DblSequence> T initRndGen(T s,
                                                   String streamName)

See Also:

Simulation.initRndGen(DblSequence, String)

simulationOf

public static Map<String,Object> simulationOf(SimProcessUtil.SimRunnable r)

See Also:

simulationOf(String, SimAction)

simulationOf

public static Map<String,Object> simulationOf(@Nullable
                                                    String name,
                                                    SimProcessUtil.SimRunnable r)

See Also:

simulationOf(String, SimAction)

simulationOf

public static Map<String,Object> simulationOf(SimComponent... components)

See Also:

simulationOf(String, SimAction)

simulationOf

public static Map<String,Object> simulationOf(@Nullable
                                                    String name,
                                                    SimComponent... components)

See Also:

simulationOf(String, SimAction)

simulationOf

public static Map<String,Object> simulationOf(SimProcessUtil.SimAction a)

See Also:

simulationOf(String, SimAction)

simulationOf

public static Map<String,Object> simulationOf(@Nullable
                                                    String name,
                                                    SimProcessUtil.SimAction a)

Create a new simulation and immediately executes it. This method only returns when the simulation is finished.

Parameters:

name - The simulation's name (can be null)

a - SimProcessUtil.SimAction defining the simulation's behavior.

Returns:

The new simulation's result map.

See Also:

Simulation.performRun(), async(String, SimAction), createSim(String, SimAction)

async

public static Future<Map<String,Object>> async(SimProcessUtil.SimRunnable r)

See Also:

async(String, SimAction)

async

public static Future<Map<String,Object>> async(@Nullable
                                                     String name,
                                                     SimProcessUtil.SimRunnable r)

See Also:

async(String, SimAction)

async

public static Future<Map<String,Object>> async(SimProcessUtil.SimAction a)

See Also:

async(String, SimAction)

async

public static Future<Map<String,Object>> async(@Nullable
                                                     String name,
                                                     SimProcessUtil.SimAction a)

Create a new simulation and run it asynchronously in a background thread.

Parameters:

name - The simulation's name (can be null)

a - SimProcessUtil.SimAction defining the simulation's behavior.

Returns:

A Future to the simulation's result map.

See Also:

Simulation.performRunAsync()

createSim

public static Simulation createSim(@Nullable
                                   String name,
                                   SimProcessUtil.SimAction a)

Create a new simulation, but does not yet execute it.

Parameters:

name - The simulation's name (can be null)

a - SimProcessUtil.SimAction defining the simulation's behavior.

Returns:

The new simulation.