Package jasima.core.simulation.util

Interface SimOperations

All Known Subinterfaces:

SimComponent, SimComponentContainer

All Known Implementing Classes:

DynamicJobSource, DynamicShopExperiment, JobSource, MimacExperiment, Shop, ShopExperiment, SimComponentBase, SimComponentContainerBase, SimComponentRoot, SimEntity, Simulation, SimulationExperiment, StaticJobSource, StaticShopExperiment, WorkStation

public interface SimOperations

Common location of simulation operations. Operations are either defined here or are calling the corresponding method in Simulation. This allows to access frequently used simulation methods in several places (e.g., SimComponent without having to duplicate code, redirecting to simulation. Furthermore some code can be moved out of Simulation to reduce its size.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SimOperations.SimEventType	Whether an event is a normal/app event or a utility event.

Method Summary

Modifier and Type	Method	Description
default <T extends SimEntity> T	activateEntity(T e)
default void	addComponent(SimComponent... scs)	Convenience method to add a one or more new component(s) to the root component of this simulation.
default void	addResult(String name, Object value)
default int	currentPrio()	Returns the current event's priority.
default void	end()	After calling end() the simulation is terminated (after handling the current event).
default SimComponentContainer	getRootComponent()
Simulation	getSim()
default Random	initRndGen(String streamName)	Creates an instance of Java's Random class initialized with a seed derived from the parameter streamName.
default <T extends DblSequence> T	initRndGen(T s, String streamName)	Initializes the random number generator associated with the DblSequence s.
default boolean	isEndRequested()	Returns true, if end() was called and the simulation run ends after processing the current event.
default boolean	isTraceEnabled()	Returns true is trace messages should be produced.
default SimEvent	schedule(SimEvent event)	Schedules a new event.
default SimEvent	scheduleAt(double time, int prio, Runnable method)	Schedules a call to method at a certain point in time.
default SimEvent	scheduleAt(double time, int prio, Runnable method, SimOperations.SimEventType eventType)
default SimEvent	scheduleAt(double time, Runnable method)
default SimEvent	scheduleAt(double time, Runnable method, SimOperations.SimEventType eventType)
default SimEvent	scheduleAt(long numUnits, TemporalUnit unit, int prio, Runnable method)	Schedules a call to method at a certain amount of time specified by numUnits and unit.
default SimEvent	scheduleAt(long numUnits, TemporalUnit unit, Runnable method)
default SimEvent	scheduleAt(String description, double time, int prio, Runnable action)	Schedules a call to method at a certain point in time.
default SimEvent	scheduleAt(String description, double time, int prio, Runnable action, SimOperations.SimEventType eventType)	Schedules a call to method at a certain point in time.
default SimEvent	scheduleAt(String description, double time, Runnable action)
default SimEvent	scheduleAt(String description, double time, Runnable action, SimOperations.SimEventType eventType)
default SimEvent	scheduleAt(String description, long numUnits, TemporalUnit unit, int prio, Runnable method)	Schedules a call to method at a certain amount of time specified by numUnits and unit.
default SimEvent	scheduleAt(String description, long numUnits, TemporalUnit unit, Runnable method)
default SimEvent	scheduleAt(String description, Instant time, int prio, Runnable method)	Schedules a call to method at a certain point in time given as a Java Instant.
default SimEvent	scheduleAt(String description, Instant time, Runnable method)
default SimEvent	scheduleAt(Instant time, int prio, Runnable method)	Schedules a call to method at a certain point in time given as a Java Instant.
default SimEvent	scheduleAt(Instant time, Runnable method)
default SimEvent	scheduleIn(double time, int prio, Runnable method)	Schedules a call to method in a certain amount of time.
default SimEvent	scheduleIn(double time, int prio, Runnable method, SimOperations.SimEventType eventType)
default SimEvent	scheduleIn(double time, Runnable method)
default SimEvent	scheduleIn(double time, Runnable method, SimOperations.SimEventType eventType)
default SimEvent	scheduleIn(long numUnits, TemporalUnit unit, int prio, Runnable method)	Schedules a call to method in a certain amount of time specified by numUnits and unit.
default SimEvent	scheduleIn(long numUnits, TemporalUnit unit, Runnable method)
default SimEvent	scheduleIn(String description, double time, int prio, Runnable method)	Schedules a call to method in a certain amount of time.
default SimEvent	scheduleIn(String description, double time, int prio, Runnable method, SimOperations.SimEventType eventType)	Schedules a call to method in a certain amount of time.
default SimEvent	scheduleIn(String description, double time, Runnable method)
default SimEvent	scheduleIn(String description, double time, Runnable method, SimOperations.SimEventType eventType)
default SimEvent	scheduleIn(String description, long numUnits, TemporalUnit unit, int prio, Runnable method)	Schedules a call to method in a certain amount of time specified by numUnits and unit.
default SimEvent	scheduleIn(String description, long numUnits, TemporalUnit unit, Runnable method)
default SimEvent	scheduleIn(String description, Duration duration, int prio, Runnable method)	Schedules a call to method in a certain amount of time.
default SimEvent	scheduleIn(String description, Duration duration, Runnable method)
default SimEvent	scheduleIn(Duration duration, int prio, Runnable method)	Schedules a call to method in a certain amount of time.
default SimEvent	scheduleIn(Duration duration, Runnable method)
default void	schedulePeriodically(double firstInvocation, double interval, int prio, Runnable method)	Periodically calls a certain method until the simulation terminates.
default void	schedulePeriodically(double firstInvocation, double interval, int prio, BooleanSupplier method)	Periodically calls a certain method.
default void	scheduleProcess(double firstInvocation, int prio, DoubleSupplier method)
default void	scheduleProcess(int prio, DoubleSupplier method)	Calls a certain method at the times returned by the method itself.
default double	simTime()	Returns the current simulation time.
default Instant	simTimeAbs()	Converts the current simulation time to a Java Instant.
default Instant	simTimeToInstant(double time)	Returns the given simulation time as an Instant.
default double	toSimTime(long numUnits, TemporalUnit u)
default double	toSimTime(Duration d)
default double	toSimTime(Instant instant)
default void	trace(Object... params)	Produces a trace message.

Method Detail

getSim

Simulation getSim()

getRootComponent

default SimComponentContainer getRootComponent()

addComponent

default void addComponent(SimComponent... scs)

Convenience method to add a one or more new component(s) to the root component of this simulation.

activateEntity

default <T extends SimEntity> T activateEntity(T e)

See Also:

Simulation.activateEntity(SimEntity)

end

default void end()

After calling end() the simulation is terminated (after handling the current event). This method might also be called from an external thread.

isEndRequested

default boolean isEndRequested()

Returns true, if end() was called and the simulation run ends after processing the current event.

simTime

default double simTime()

Returns the current simulation time.

See Also:

Simulation.simTime()

currentPrio

default int currentPrio()

Returns the current event's priority.

See Also:

Simulation.currentPrio()

simTimeAbs

default Instant simTimeAbs()

Converts the current simulation time to a Java Instant.

See Also:

simTimeToInstant(double)

simTimeToInstant

default Instant simTimeToInstant(double time)

Returns the given simulation time as an Instant.

See Also:

Simulation.simTimeToInstant(double)

schedule

default SimEvent schedule(SimEvent event)

Schedules a new event.

See Also:

Simulation.schedule(SimEvent)

scheduleAt

default SimEvent scheduleAt(double time,
                            int prio,
                            Runnable method)

Schedules a call to method at a certain point in time. Instead of calling this method it is usually better to use scheduleAt(String, double, int, Runnable) instead, as the additional description parameter usually makes debugging easier.

Parameters:

time - The time when to call method.

prio - Priority of the event (to deterministically sequence events at the same time).

method - The method to call at the given moment.

Returns:

The SimEvent that was added to the event queue (to allow usage in, e.g., Simulation.unschedule(SimEvent)).

scheduleAt

default SimEvent scheduleAt(double time,
                            Runnable method)

See Also:

scheduleAt(double, int, Runnable)

scheduleAt

default SimEvent scheduleAt(@Nullable
                            String description,
                            double time,
                            int prio,
                            Runnable action)

Schedules a call to method at a certain point in time.

Parameters:

description - Some description that is added as an additional parameter to the Event object (makes debugging easier).

time - The time when to call method.

prio - Priority of the event (to deterministically sequence events at the same time).

action - The method to call at the given moment.

Returns:

The SimEvent that was added to the event queue (to allow usage in, e.g., Simulation.unschedule(SimEvent)).

scheduleAt

default SimEvent scheduleAt(@Nullable
                            String description,
                            double time,
                            Runnable action)

See Also:

scheduleAt(String, double, int, Runnable)

scheduleAt

default SimEvent scheduleAt(double time,
                            int prio,
                            Runnable method,
                            SimOperations.SimEventType eventType)

See Also:

scheduleAt(String, double, int, Runnable, SimEventType)

scheduleAt

default SimEvent scheduleAt(double time,
                            Runnable method,
                            SimOperations.SimEventType eventType)

See Also:

scheduleAt(double, int, Runnable, SimEventType)

scheduleAt

default SimEvent scheduleAt(@Nullable
                            String description,
                            double time,
                            int prio,
                            Runnable action,
                            @Nullable
                            SimOperations.SimEventType eventType)

Schedules a call to method at a certain point in time.

Parameters:

description - Some description that is added as an additional parameter to the Event object (makes debugging easier).

time - The time when to call method.

prio - Priority of the event (to deterministically sequence events at the same time).

action - The method to call at the given moment.

eventType - Whether the event is a normal/app event or a utility event. null is treated like an app event.

Returns:

The SimEvent that was added to the event queue (to allow usage in, e.g., Simulation.unschedule(SimEvent)).

scheduleAt

default SimEvent scheduleAt(@Nullable
                            String description,
                            double time,
                            Runnable action,
                            SimOperations.SimEventType eventType)

See Also:

scheduleAt(String, double, int, Runnable, SimEventType)

scheduleAt

default SimEvent scheduleAt(Instant time,
                            int prio,
                            Runnable method)

Schedules a call to method at a certain point in time given as a Java Instant. Usually using scheduleAt(String, Instant, int, Runnable) should be preferred.

Parameters:

time - The time when to call method.

prio - Priority of the event (to deterministically sequence events at the same time).

method - The method to call at the given moment.

Returns:

The SimEvent that was added to the event queue (to allow usage in, e.g., Simulation.unschedule(SimEvent)).

scheduleAt

default SimEvent scheduleAt(Instant time,
                            Runnable method)

See Also:

scheduleAt(Instant, int, Runnable)

scheduleAt

default SimEvent scheduleAt(@Nullable
                            String description,
                            Instant time,
                            int prio,
                            Runnable method)

Schedules a call to method at a certain point in time given as a Java Instant.

Parameters:

description - Some description that is added as an additional parameter to the Event object (makes debugging easier).

time - The time when to call method.

prio - Priority of the event (to deterministically sequence events at the same time).

method - The method to call at the given moment.

Returns:

The SimEvent that was added to the event queue (to allow usage in, e.g., Simulation.unschedule(SimEvent)).

scheduleAt

default SimEvent scheduleAt(@Nullable
                            String description,
                            Instant time,
                            Runnable method)

See Also:

scheduleAt(String, Instant, int, Runnable)

scheduleAt

default SimEvent scheduleAt(long numUnits,
                            TemporalUnit unit,
                            int prio,
                            Runnable method)

Schedules a call to method at a certain amount of time specified by numUnits and unit.

Usually using scheduleAt(String, long, TemporalUnit, int, Runnable) should be preferred.

Parameters:

numUnits - The time duration.

unit - The time unit of numUnits.

prio - Priority of the event (to deterministically sequence events at the same time).

method - The method to call at the given moment.

Returns:

The SimEvent that was added to the event queue (to allow usage in, e.g., Simulation.unschedule(SimEvent)).

scheduleAt

default SimEvent scheduleAt(long numUnits,
                            TemporalUnit unit,
                            Runnable method)

See Also:

scheduleAt(long, TemporalUnit, int, Runnable)

scheduleAt

default SimEvent scheduleAt(@Nullable
                            String description,
                            long numUnits,
                            TemporalUnit unit,
                            int prio,
                            Runnable method)

Schedules a call to method at a certain amount of time specified by numUnits and unit.

Parameters:

description - Some description that is added as an additional parameter to the Event object (makes debugging easier).

numUnits - The time.

unit - The time unit of numUnits.

prio - Priority of the event (to deterministically sequence events at the same time).

method - The method to call at the given moment.

Returns:

The SimEvent that was added to the event queue (to allow usage in, e.g., Simulation.unschedule(SimEvent)).

scheduleAt

default SimEvent scheduleAt(@Nullable
                            String description,
                            long numUnits,
                            TemporalUnit unit,
                            Runnable method)

See Also:

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

scheduleIn

default SimEvent scheduleIn(double time,
                            int prio,
                            Runnable method)

Schedules a call to method in a certain amount of time. In contrast to scheduleAt(double, int, Runnable) this method expects a relative time instead of an absolute one.

Usually using scheduleIn(String, double, int, Runnable) should be preferred.

Parameters:

time - The time when to call method.

prio - Priority of the event (to deterministically sequence events at the same time).

method - The method to call at the given moment.

Returns:

The SimEvent that was added to the event queue (to allow usage in, e.g., Simulation.unschedule(SimEvent)).

scheduleIn

default SimEvent scheduleIn(double time,
                            Runnable method)

See Also:

scheduleIn(double, int, Runnable)

scheduleIn

default SimEvent scheduleIn(double time,
                            int prio,
                            Runnable method,
                            SimOperations.SimEventType eventType)

See Also:

scheduleIn(String, double, int, Runnable, SimEventType)

scheduleIn

default SimEvent scheduleIn(double time,
                            Runnable method,
                            SimOperations.SimEventType eventType)

See Also:

scheduleIn(double, int, Runnable, SimEventType)

scheduleIn

default SimEvent scheduleIn(@Nullable
                            String description,
                            double time,
                            int prio,
                            Runnable method)

Schedules a call to method in a certain amount of time. In contrast to scheduleAt(double, int, Runnable) this method expects a relative time instead of an absolute one.

Parameters:

description - Some description that is added as an additional parameter to the Event object (makes debugging easier).

time - The time when to call method.

prio - Priority of the event (to deterministically sequence events at the same time).

method - The method to call at the given moment.

Returns:

The SimEvent that was added to the event queue (to allow usage in, e.g., Simulation.unschedule(SimEvent)).

scheduleIn

default SimEvent scheduleIn(@Nullable
                            String description,
                            double time,
                            Runnable method)

See Also:

scheduleIn(String, double, int, Runnable)

scheduleIn

default SimEvent scheduleIn(@Nullable
                            String description,
                            double time,
                            int prio,
                            Runnable method,
                            SimOperations.SimEventType eventType)

Schedules a call to method in a certain amount of time. In contrast to scheduleAt(double, int, Runnable) this method expects a relative time instead of an absolute one.

Parameters:

description - Some description that is added as an additional parameter to the Event object (makes debugging easier).

time - The time when to call method.

prio - Priority of the event (to deterministically sequence events at the same time).

method - The method to call at the given moment.

eventType - Whether the event is a normal/app event or a utility event.

Returns:

The SimEvent that was added to the event queue (to allow usage in, e.g., Simulation.unschedule(SimEvent)).

scheduleIn

default SimEvent scheduleIn(@Nullable
                            String description,
                            double time,
                            Runnable method,
                            SimOperations.SimEventType eventType)

See Also:

#scheduleIn(String, double, int, Runnable, boolean)

scheduleIn

default SimEvent scheduleIn(Duration duration,
                            int prio,
                            Runnable method)

Schedules a call to method in a certain amount of time. In contrast to scheduleAt(double, int, Runnable) this method expects a relative time specified by a Duration instead of an absolute one.

Usually using scheduleIn(String, Duration, int, Runnable) should be preferred.

Parameters:

duration - The duration from the current simulation time when to call method.

prio - Priority of the event (to deterministically sequence events at the same time).

method - The method to call at the given moment.

Returns:

The SimEvent that was added to the event queue (to allow usage in, e.g., Simulation.unschedule(SimEvent)).

scheduleIn

default SimEvent scheduleIn(Duration duration,
                            Runnable method)

See Also:

scheduleIn(Duration, int, Runnable)

scheduleIn

default SimEvent scheduleIn(@Nullable
                            String description,
                            Duration duration,
                            int prio,
                            Runnable method)

Schedules a call to method in a certain amount of time. In contrast to scheduleAt(double, int, Runnable) this method expects a relative time specified by a Duration instead of an absolute one.

Parameters:

description - Some description that is added as an additional parameter to the Event object (makes debugging easier).

duration - The duration from the current simulation time when to call method.

prio - Priority of the event (to deterministically sequence events at the same time).

method - The method to call at the given moment.

Returns:

The SimEvent that was added to the event queue (to allow usage in, e.g., Simulation.unschedule(SimEvent)).

scheduleIn

default SimEvent scheduleIn(@Nullable
                            String description,
                            Duration duration,
                            Runnable method)

See Also:

scheduleIn(String, Duration, int, Runnable)

scheduleIn

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

Schedules a call to method in a certain amount of time specified by numUnits and unit.

Usually using scheduleIn(String, long, TemporalUnit, int, Runnable) should be preferred.

Parameters:

numUnits - The time duration.

unit - The time unit of numUnits.

prio - Priority of the event (to deterministically sequence events at the same time).

method - The method to call at the given moment.

Returns:

The SimEvent that was added to the event queue (to allow usage in, e.g., Simulation.unschedule(SimEvent)).

scheduleIn

default SimEvent scheduleIn(long numUnits,
                            TemporalUnit unit,
                            Runnable method)

See Also:

scheduleIn(long, TemporalUnit, int, Runnable)

scheduleIn

default SimEvent scheduleIn(@Nullable
                            String description,
                            long numUnits,
                            TemporalUnit unit,
                            int prio,
                            Runnable method)

Schedules a call to method in a certain amount of time specified by numUnits and unit.

Parameters:

description - Some description that is added as an additional parameter to the Event object (makes debugging easier).

numUnits - The time duration.

unit - The time unit of numUnits.

prio - Priority of the event (to deterministically sequence events at the same time).

method - The method to call at the given moment.

Returns:

The SimEvent that was added to the event queue (to allow usage in, e.g., Simulation.unschedule(SimEvent)).

scheduleIn

default SimEvent scheduleIn(@Nullable
                            String description,
                            long numUnits,
                            TemporalUnit unit,
                            Runnable method)

See Also:

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

schedulePeriodically

default void schedulePeriodically(double firstInvocation,
                                  double interval,
                                  int prio,
                                  BooleanSupplier method)

Periodically calls a certain method. While this method returns true, a next invocation after the given time interval is scheduled.

See Also:

Simulation.schedulePeriodically(double, double, int, BooleanSupplier)

schedulePeriodically

default void schedulePeriodically(double firstInvocation,
                                  double interval,
                                  int prio,
                                  Runnable method)

Periodically calls a certain method until the simulation terminates.

See Also:

Simulation.schedulePeriodically(double, double, int, Runnable)

scheduleProcess

default void scheduleProcess(int prio,
                             DoubleSupplier method)

Calls a certain method at the times returned by the method itself. The first invocation is performed at the current time (asynchronously, i.e., scheduleProcess() returns before method is called for the first time). Subsequent calls are scheduled at the absolute times returned by the previous method invocation. No more invocations are scheduled if method returned NaN or a negative value.

See Also:

Simulation.scheduleProcess(int, DoubleSupplier)

scheduleProcess

default void scheduleProcess(double firstInvocation,
                             int prio,
                             DoubleSupplier method)

See Also:

Simulation.scheduleProcess(double, int, DoubleSupplier)

toSimTime

default double toSimTime(Instant instant)

See Also:

Simulation.toSimTime(Instant)

toSimTime

default double toSimTime(Duration d)

See Also:

Simulation.toSimTime(Duration)

toSimTime

default double toSimTime(long numUnits,
                         TemporalUnit u)

See Also:

Simulation.toSimTime(long, TemporalUnit)

addResult

default void addResult(String name,
                       Object value)

See Also:

Simulation.addResult(String, Object)

trace

default void trace(Object... params)

Produces a trace message.

See Also:

Simulation.trace(Object...)

isTraceEnabled

default boolean isTraceEnabled()

Returns true is trace messages should be produced.

See Also:

Simulation.isTraceEnabled()

initRndGen

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

Initializes the random number generator associated with the DblSequence s. This just delegates to the RandomFactory of a simulation.

See Also:

Simulation.initRndGen(DblSequence, String)

initRndGen

default Random initRndGen(String streamName)

Creates an instance of Java's Random class initialized with a seed derived from the parameter streamName. This just delegates to the method RandomFactory.createInstance(String) of a simulation.

See Also:

Simulation.initRndGen(String)