java.lang.Object
- jasima.core.simulation.Simulation

All Implemented Interfaces:

ProcessActivator, SimOperations, Notifier<Simulation,Simulation.SimLifecycleEvent>, ValueStore
```
public class Simulation
extends Object
implements ValueStore, SimOperations, ProcessActivator, Notifier<Simulation,Simulation.SimLifecycleEvent>
```
Base class for a discrete event simulation. This class mainly maintains the event queue and manages simulation time. Additionally it offers a centralized place to initialize random number streams and to create status and debug messages.
The typical life cycle of a simulation would be to create it, and subsequently set any parameters. Afterwards init() has to be called before the actual simulation can be performed in run(). After completing a simulation the done()-method should be called to perform clean-up, collecting simulation results, etc. As a final step usually produceResults(Map) is called to allow the simulation and all simulation components to report simulation results.

Author:

Torsten Hildebrandt

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static interface`	`Simulation.ErrorHandler`
`static class`	`Simulation.ProduceResultsMessage`	Message send when all `SimComponent`s are requested to produce results.
`static class`	`Simulation.SimExecState`
`static interface`	`Simulation.SimLifecycleEvent`
`static class`	`Simulation.SimulationFailed`
`static class`	`Simulation.StdSimLifecycleEvents`

Nested classes/interfaces inherited from interface jasima.core.simulation.util.SimOperations
SimOperations.SimEventType

Field Summary

Fields
Modifier and Type Field Description

static String QUEUE_IMPL_KEY

static Class<? extends EventQueue> queueImpl

static String SIM_TIME
- Fields inherited from interface jasima.core.util.observer.Notifier
  adapters
- Fields inherited from interface jasima.core.simulation.util.ProcessActivator
  log

Constructor Summary

Constructors
Constructor Description

Simulation()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`<T extends SimEntity> T`	`activateEntity(T e)`	Activates the given entity but does not add it to the components tree.
`void`	`addPrintListener(Consumer<SimPrintMessage> listener)`
`void`	`addResult(String name, Object value)`	Adds a certain result to the simulation's result Map.
`void`	`afterRun()`	Override this method to perform some action after running the simulation, but before `done()` is called.
`void`	`beforeRun()`	Override this method to perform initializations after `init()`, but before running the simulation.
`Clock`	`clock()`	Returns a Java `Clock` object using the simulation time and its time zone.
`boolean`	`continueSim()`
`protected EventQueue`	`createEventQueue()`	Factory method to create a new event queue.
`SimEvent`	`currentEvent()`	Returns the `SimEvent` object that is currently processed.
`int`	`currentPrio()`	Returns the priority of the currently processed event.
`SimProcess<?>`	`currentProcess()`	Returns the currently active `SimProcess`.
`protected boolean`	`defaultErrorHandler(Exception e)`
`void`	`done()`	Performs clean-up etc., after a simulation's `run()` method finished.
`void`	`end()`	After calling end() the simulation is terminated (after handling the current event).
`String`	`formattedMessage(Enum<?> key, Object... params)`
`SimComponent`	`getComponentByHierarchicalName(String hierarchicalName)`	Convenience method to get a component by its name given a fully qualified name such as "container1.sub1.myMachine".
`Simulation.ErrorHandler`	`getErrorHandler()`
`int`	`getInitialEventPriority()`
`double`	`getInitialSimTime()`
`Locale`	`getLocale()`	Returns the currently set `Locale`, i.e., language and region.
`SimProcessUtil.SimAction`	`getMainProcessActions()`
`String`	`getName()`
`MsgCategory`	`getPrintLevel()`
`RandomFactory`	`getRndStreamFactory()`
`SimComponentRoot`	`getRootComponent()`
`Simulation`	`getSim()`
`Instant`	`getSimTimeStartInstant()`	Returns the `Instant` corresponding to the initial simulation time.
`long`	`getSimTimeToMillisFactor()`	Returns the factor used to convert the (double-valued) simulation time to milli-seconds since `getSimTimeStartInstant()`.
`double`	`getSimulationLength()`
`double`	`getStatsResetTime()`	Returns the statistics reset time.
`ZoneId`	`getZoneId()`
`void`	`init()`	Performs all initializations required for a successful simulation `run()`.
`protected void`	`initComponentTree(SimComponent parent, SimComponent child)`	Recursively initialize components before run by setting simulation and parent node.
`Random`	`initRndGen(String streamName)`	Creates an instance of Java's `Random` class initialized with a seed derived from the parameter `streamName`.
`<T extends DblSequence> T`	`initRndGen(T s, String streamName)`	Initializes the random number generator associated with the `DblSequence` `s`.
`boolean`	`isEndRequested()`	Returns true, if `SimOperations.end()` was called and the simulation run ends after processing the current event.
`boolean`	`isTraceEnabled()`	Returns true is trace messages should be produced.
`String`	`message(Enum<?> key)`
`String`	`message(String keyName)`
`NotifierImpl<Simulation,Simulation.SimLifecycleEvent>`	`notifierImpl()`
`long`	`numAppEvents()`	Returns the number of normal, i.e., application events currently contained in the event queue.
`long`	`numEvents()`	Returns the total number of events (both application and utility events) currently contained in the event queue.
`long`	`numEventsProcessed()`	Returns the number of events processed by the main simulation loop.
`int`	`numPrintListener()`
`int`	`numRunnableProcesses()`
`ObservableValue<Simulation.SimExecState>`	`observableState()`	Returns the current simulation execution state.
`static Map<String,Object>`	`of(SimComponent... components)`
`static Map<String,Object>`	`of(SimProcessUtil.SimAction a)`
`static Map<String,Object>`	`of(SimProcessUtil.SimRunnable r)`
`static Map<String,Object>`	`of(String name, SimComponent... components)`
`static Map<String,Object>`	`of(String name, SimProcessUtil.SimAction a)`
`static Map<String,Object>`	`of(String name, SimProcessUtil.SimRunnable r)`
`void`	`pause()`	After calling `pause()` the simulation is paused.
`Map<String,Object>`	`performRun()`	Convenience method calling `init()`, `beforeRun()`, `run()`, `afterRun()`, `done()` and returning the results produced by `produceResults(Map)` in a new `HashMap`.
`Future<Map<String,Object>>`	`performRunAsync()`	Trigger asynchronous execution of the simulation in the default thread pool.
`Future<Map<String,Object>>`	`performRunAsync(ExecutorService pool)`	Call the `performRun()` method in an asynchronous way.
`protected void`	`print(SimPrintMessage e)`	Prints a certain `SimPrintMessage` by passing it to the registered print listeners.
`void`	`print(MsgCategory category, Object... params)`	Triggers a print event of the given category.
`void`	`print(MsgCategory category, String message)`	Triggers a print event of the given category.
`void`	`print(String message)`	Triggers a print event for the given message of category "INFO".
`void`	`printFmt(MsgCategory category, String messageFormatString, Object... params)`	Triggers a print event of the given category with the message produced by a Java format String.
`void`	`printFmt(String messageFormatString, Object... params)`	Same as `printFmt(MsgCategory, String, Object...)`, but defaulting to category `INFO`.
`List<Consumer<SimPrintMessage>>`	`printListener()`
`void`	`produceResults(Map<String,Object> res)`	Populates the given HashMap with results produced in the simulation run.
`boolean`	`removePrintListener(Consumer<SimPrintMessage> listener)`
`protected void`	`resetStats()`	This method is called once after `beforeRun()` and immediately before the main simulation loop starts.
`void`	`run()`	Runs the main simulation loop.
`protected void`	`runEventHandler(SimEvent evt)`	Runs the handle-method of `evt` (see `SimEvent.handle()`.
`void`	`runInSimThread(SimProcessUtil.SimAction a)`
`void`	`runInSimThread(Runnable r)`
`List<SimProcess<?>>`	`runnableProcesses()`
`SimEvent`	`schedule(SimEvent event)`	Schedules a new event.
`List<SimEvent>`	`scheduledEvents()`	Returns an ordered list of all events currently in the event queue.
`void`	`schedulePeriodically(double firstInvocation, double interval, int prio, Runnable method)`	Periodically calls a certain method until the simulation terminates.
`void`	`schedulePeriodically(double firstInvocation, double interval, int prio, BooleanSupplier method)`	Periodically calls a certain method.
`void`	`scheduleProcess(double firstInvocation, int prio, DoubleSupplier method)`	Calls a certain method at the times returned by the method itself.
`void`	`scheduleProcess(int prio, DoubleSupplier method)`	Calls a certain method at the times returned by the method itself.
`void`	`setErrorHandler(Simulation.ErrorHandler errorHandler)`
`void`	`setInitialEventPriority(int initialEventPriority)`	Sets the initial priority value (default=0, i.e., `SimEvent.EVENT_PRIO_NORMAL`).
`void`	`setInitialSimTime(double initialSimTime)`	Sets the initial value of the simulation clock.
`void`	`setLocale(Locale locale)`	Sets the current `Locale`.
`void`	`setMainProcessActions(SimProcessUtil.SimAction mainProcessActions)`
`void`	`setMainProcessActions(SimProcessUtil.SimRunnable r)`
`void`	`setName(String name)`	Sets a name for this simulation.
`void`	`setPrintLevel(MsgCategory printLevel)`	Sets the maximum print message category to be forwared to the print listeners.
`void`	`setRndStreamFactory(RandomFactory rndStreamFactory)`	Sets the random factory to use to create random number streams for stochastic simulations.
`void`	`setSimTimeStartInstant(Instant simTimeStartInstant)`	Sets the `Instant` corresponding to the a simulation time of 0.
`void`	`setSimTimeToMillisFactor(long simTimeToMillisFactor)`	Sets the factor used to convert the (double-valued) simulation time to milli-seconds since `getSimTimeStartInstant()`.
`void`	`setSimTimeToMillisFactor(TemporalUnit u)`	Specifies the time unit of the (double-valued) simulation time.
`void`	`setSimulationLength(double simulationLength)`	Sets the maximum simulation time.
`void`	`setStatsResetTime(double statsResetTime)`	Sets the time when to perform a statistics reset.
`void`	`setZoneId(ZoneId zone)`	Sets the current time zone (used by `simTimeToLocalDateTime()`.
`double`	`simTime()`	Returns the current simulation time.
`Duration`	`simTimeToDuration(double simTime)`	Converts the given simulation time span to a Java `Duration`.
`Instant`	`simTimeToInstant(double simTime)`	Converts the given simulation time to a Java `Instant` (UTC time stamp).
`LocalDateTime`	`simTimeToLocalDateTime()`	Converts the current simulation time to a Java `LocalDateTime`.
`LocalDateTime`	`simTimeToLocalDateTime(double simTime)`	Converts a simulation time to a Java `LocalDateTime`.
`LocalDateTime`	`simTimeToLocalDateTime(Instant instant)`	Converts the given `Instant` to a local date/time at this simulation's zone id (`getZoneId()`.
`Simulation.SimExecState`	`state()`	Returns the current simulation execution state.
`double`	`toSimTime(long numUnits, TemporalUnit u)`	Converts a given number of `TemporalUnit`s to the corresponding simulation time, like `double time = sim.toSimTime(5, ChronoUnit.MINUTE)`.
`double`	`toSimTime(Duration d)`	Converts a given Java `Duration` (i.e., a time span) to the corresponding (relative) simulation time.
`double`	`toSimTime(Instant instant)`	Converts a given Java `Instant` (absolute UTC time stamp) to the simulation time it corresponds to.
`void`	`trace(Object... params)`	Produces a trace message (if there are any print listeners such as `TraceFileProducer` are registered that do something with such messages).
`void`	`unpause()`	After calling `unpause()` a paused simulation is continued.
`boolean`	`unschedule(SimEvent event)`	Removes the given event object from the event queue.
`ValueStore`	`valueStoreImpl()`	Returns the implementation to use for adding ValueStore functionality.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jasima.core.util.observer.Notifier
addListener, addListener, addListener, fire, fire, getListener, numListener, removeCurrentListener, removeListener

Methods inherited from interface jasima.core.simulation.util.ProcessActivator
activate, activate, activate, activate, activateCallable, activateCallable, activateCallable, activateCallable

Methods inherited from interface jasima.core.simulation.util.SimOperations
addComponent, scheduleAt, scheduleAt, scheduleAt, scheduleAt, scheduleAt, scheduleAt, scheduleAt, scheduleAt, scheduleAt, scheduleAt, scheduleAt, scheduleAt, scheduleAt, scheduleAt, scheduleAt, scheduleAt, scheduleIn, scheduleIn, scheduleIn, scheduleIn, scheduleIn, scheduleIn, scheduleIn, scheduleIn, scheduleIn, scheduleIn, scheduleIn, scheduleIn, scheduleIn, scheduleIn, scheduleIn, scheduleIn, simTimeAbs

Methods inherited from interface jasima.core.util.ValueStore
valueStoreContains, valueStoreGet, valueStoreGet, valueStoreGetAllKeys, valueStoreGetNumKeys, valueStorePut, valueStoreRemove, valueStoreUpdate

- Field Detail
  - SIM_TIME
```
public static final String SIM_TIME
```
    See Also:
    
    Constant Field Values
  - QUEUE_IMPL_KEY
```
public static final String QUEUE_IMPL_KEY
```
    See Also:
    
    Constant Field Values
  - queueImpl
```
public static final Class<? extends EventQueue> queueImpl
```
- Constructor Detail
  - Simulation
```
public Simulation()
```
- Method Detail
  - notifierImpl
```
public NotifierImpl<Simulation,Simulation.SimLifecycleEvent> notifierImpl()
```
    Specified by:
    
    notifierImpl in interface Notifier<Simulation,Simulation.SimLifecycleEvent>
  - of
```
public static Map<String,Object> of(SimProcessUtil.SimRunnable r)
```
  - of
```
public static Map<String,Object> of(String name,
                                          SimProcessUtil.SimRunnable r)
```
  - of
```
public static Map<String,Object> of(SimComponent... components)
```
  - of
```
public static Map<String,Object> of(String name,
                                          SimComponent... components)
```
  - of
```
public static Map<String,Object> of(SimProcessUtil.SimAction a)
```
  - of
```
public static Map<String,Object> of(String name,
                                          SimProcessUtil.SimAction a)
```
  - addPrintListener
```
public void addPrintListener(Consumer<SimPrintMessage> listener)
```
  - removePrintListener
```
public boolean removePrintListener(Consumer<SimPrintMessage> listener)
```
  - numPrintListener
```
public int numPrintListener()
```
  - printListener
```
public List<Consumer<SimPrintMessage>> printListener()
```
  - init
```
public void init()
```
    Performs all initializations required for a successful simulation run().
  - initComponentTree
```
protected void initComponentTree(SimComponent parent,
                                 SimComponent child)
```
    Recursively initialize components before run by setting simulation and parent node.
    
    Parameters:
    
    parent -
    
    child -
  - run
```
public void run()
```
    Runs the main simulation loop. This means:
    
    taking an event from the event queue,
    advancing simulation time, and
    triggering event processing.
    A simulation is terminated if either the maximum simulation length is reached, there are no more application events in the queue, or the method end() was called.
    See Also:
    
    SimEvent.isAppEvent()
  - runEventHandler
```
protected void runEventHandler(SimEvent evt)
```
    Runs the handle-method of evt (see SimEvent.handle(). This method exists to allow executing custom code before and after each event by sub-classing Simulation.
    
    Parameters:
    
    evt - The event to execute
  - defaultErrorHandler
```
protected boolean defaultErrorHandler(Exception e)
```
  - beforeRun
```
public void beforeRun()
```
    Override this method to perform initializations after init(), but before running the simulation. This method is usually used to schedule initial events. It is executed automatically at the beginning of the run() method.
  - resetStats
```
protected void resetStats()
```
    This method is called once after beforeRun() and immediately before the main simulation loop starts. It is called a second time if the simulation has a a value for statsResetTime() set.
    It should contain code to initialize statistics variables.
  - afterRun
```
public void afterRun()
```
    Override this method to perform some action after running the simulation, but before done() is called. It is executed automatically at the end of the run() method.
  - done
```
public void done()
```
    Performs clean-up etc., after a simulation's run() method finished.
  - performRun
```
public Map<String,Object> performRun()
```
    Convenience method calling init(), beforeRun(), run(), afterRun(), done() and returning the results produced by produceResults(Map) in a new HashMap.
    
    Returns:
    
    The results produced by the simulation and its components.
  - performRunAsync
```
public Future<Map<String,Object>> performRunAsync(ExecutorService pool)
```
    Call the performRun() method in an asynchronous way.
    
    Parameters:
    
    pool - The ExecutorService to use.
    
    Returns:
    
    A Future to obtain the simulation results.
    
    See Also:
    
    performRun(), performRunAsync()
  - performRunAsync
```
public Future<Map<String,Object>> performRunAsync()
```
    Trigger asynchronous execution of the simulation in the default thread pool.
    
    Returns:
    
    A Future to obtain the simulation results.
    
    See Also:
    
    performRun(), performRunAsync(ExecutorService)
  - unschedule
```
public boolean unschedule(SimEvent event)
```
    Removes the given event object from the event queue.
    
    Parameters:
    
    event - the event to remove
    
    Returns:
    
    true if the operation was present in the event queue and could be successfully removed, false otherwise
  - schedule
```
public SimEvent schedule(SimEvent event)
```
    Schedules a new event.
    
    Specified by:
    
    schedule in interface SimOperations
    
    Parameters:
    
    event - Some future event to be executed by the main event loop.
    
    See Also:
    
    schedule(SimEvent)
  - schedulePeriodically
```
public 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.
    
    Specified by:
    
    schedulePeriodically in interface SimOperations
    
    See Also:
    
    schedulePeriodically(double, double, int, BooleanSupplier)
  - schedulePeriodically
```
public void schedulePeriodically(double firstInvocation,
                                 double interval,
                                 int prio,
                                 Runnable method)
```
    Periodically calls a certain method until the simulation terminates.
    
    Specified by:
    
    schedulePeriodically in interface SimOperations
    
    See Also:
    
    schedulePeriodically(double, double, int, Runnable)
  - scheduleProcess
```
public 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.
    
    Specified by:
    
    scheduleProcess in interface SimOperations
    
    See Also:
    
    scheduleProcess(int, DoubleSupplier)
  - scheduleProcess
```
public void scheduleProcess(double firstInvocation,
                            int prio,
                            DoubleSupplier method)
```
    Calls a certain method at the times returned by the method itself. The first invocation is performed at firstInvocation. 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.
    
    Specified by:
    
    scheduleProcess in interface SimOperations
    
    See Also:
    
    scheduleProcess(double, int, DoubleSupplier)
  - end
```
public void end()
```
    After calling end() the simulation is terminated (after handling the current event). This method might also be called from an external thread.
    
    Specified by:
    
    end in interface SimOperations
  - isEndRequested
```
public boolean isEndRequested()
```
    Returns true, if SimOperations.end() was called and the simulation run ends after processing the current event.
    
    Specified by:
    
    isEndRequested in interface SimOperations
  - pause
```
public void pause()
```
    After calling pause() the simulation is paused. This means, the run() method returns after handling the current event.
    This method might also be called from an external thread.
  - unpause
```
public void unpause()
```
    After calling unpause() a paused simulation is continued. Internally each pause request increases a counter that has to be followed by an unpause request. Simulation only resumes if the pause counter reaches zero.
    This method might also be called from an external thread.
  - simTime
```
public double simTime()
```
    Returns the current simulation time.
    
    Specified by:
    
    simTime in interface SimOperations
    
    See Also:
    
    simTime()
  - clock
```
public Clock clock()
```
    Returns a Java Clock object using the simulation time and its time zone.
  - simTimeToLocalDateTime
```
public LocalDateTime simTimeToLocalDateTime()
```
    Converts the current simulation time to a Java LocalDateTime. This converts the current simulation time to an Instant first (see SimOperations.simTimeAbs()) and then converts it to the local time for this simulation's zone id (getZoneId().
    
    See Also:
    
    simTimeToInstant(double)
  - simTimeToLocalDateTime
```
public LocalDateTime simTimeToLocalDateTime(double simTime)
```
    Converts a simulation time to a Java LocalDateTime. The simulation time is converted to an Instant first (see SimOperations.simTimeAbs()) and then converted to the local time for this simulation's zone id (see getZoneId().
    
    See Also:
    
    simTimeToInstant(double)
  - simTimeToLocalDateTime
```
public LocalDateTime simTimeToLocalDateTime(Instant instant)
```
    Converts the given Instant to a local date/time at this simulation's zone id (getZoneId().
    
    See Also:
    
    simTimeToInstant(double)
  - simTimeToInstant
```
public Instant simTimeToInstant(double simTime)
```
    Converts the given simulation time to a Java Instant (UTC time stamp). Conversion multiplies the time with the factor getSimTimeToMillisFactor() and rounds the results to the closest integer to get the number of milliseconds since a simTime of 0. This amount of milliseconds is then added to getSimTimeStartInstant() to get an absolute Java time stamp.
    
    Specified by:
    
    simTimeToInstant in interface SimOperations
    
    See Also:
    
    setSimTimeStartInstant(Instant), setSimTimeToMillisFactor(long)
  - simTimeToDuration
```
public Duration simTimeToDuration(double simTime)
```
    Converts the given simulation time span to a Java Duration.
  - toSimTime
```
public double toSimTime(Instant instant)
```
    Converts a given Java Instant (absolute UTC time stamp) to the simulation time it corresponds to.
    
    Specified by:
    
    toSimTime in interface SimOperations
    
    Parameters:
    
    instant - The instant to be converted to simulation time.
    
    Returns:
    
    The instant converted to simulation time.
    
    See Also:
    
    toSimTime(Instant)
  - toSimTime
```
public double toSimTime(Duration d)
```
    Converts a given Java Duration (i.e., a time span) to the corresponding (relative) simulation time.
    
    Specified by:
    
    toSimTime in interface SimOperations
    
    Parameters:
    
    d - The duration to be converted to simulation time.
    
    Returns:
    
    The amount of simulation time.
    
    See Also:
    
    toSimTime(Duration)
  - toSimTime
```
public double toSimTime(long numUnits,
                        TemporalUnit u)
```
    Converts a given number of TemporalUnits to the corresponding simulation time, like double time = sim.toSimTime(5, ChronoUnit.MINUTE). Internally this creates a temporary Duration object and then calls toSimTime(Duration).
    
    Specified by:
    
    toSimTime in interface SimOperations
    
    Parameters:
    
    numUnits - the amount of time units
    
    u - the temporal unit to use; will usually be on from ChronoUnit
    
    Returns:
    
    The amount of simulation time.
    
    See Also:
    
    toSimTime(long, TemporalUnit)
  - currentPrio
```
public int currentPrio()
```
    Returns the priority of the currently processed event.
    
    Specified by:
    
    currentPrio in interface SimOperations
    
    See Also:
    
    currentPrio()
  - currentEvent
```
public SimEvent currentEvent()
```
    Returns the SimEvent object that is currently processed.
  - currentProcess
```
@Nullable
public SimProcess<?> currentProcess()
```
    Returns the currently active SimProcess.
  - state
```
public Simulation.SimExecState state()
```
    Returns the current simulation execution state.
  - observableState
```
public ObservableValue<Simulation.SimExecState> observableState()
```
    Returns the current simulation execution state.
  - numEventsProcessed
```
public long numEventsProcessed()
```
    Returns the number of events processed by the main simulation loop.
  - numAppEvents
```
public long numAppEvents()
```
    Returns the number of normal, i.e., application events currently contained in the event queue.
  - numEvents
```
public long numEvents()
```
    Returns the total number of events (both application and utility events) currently contained in the event queue.
  - scheduledEvents
```
public List<SimEvent> scheduledEvents()
```
    Returns an ordered list of all events currently in the event queue. Use with care, this is an expensive operation. The list does not include the current
  - produceResults
```
public void produceResults(Map<String,Object> res)
```
    Populates the given HashMap with results produced in the simulation run.
  - addResult
```
public void addResult(String name,
                      Object value)
```
    Adds a certain result to the simulation's result Map.
    
    Specified by:
    
    addResult in interface SimOperations
    
    Parameters:
    
    name - Name of the result.
    
    value - Result value.
    
    See Also:
    
    addResult(String, Object)
  - activateEntity
```
public <T extends SimEntity> T activateEntity(T e)
```
    Activates the given entity but does not add it to the components tree. Therefore they will not be notified of any future simulation lifecycle events such as produceResults. It is therefore intended for temporary SimEntitys only.
    
    Specified by:
    
    activateEntity in interface SimOperations
    
    See Also:
    
    activateEntity(SimEntity)
  - getComponentByHierarchicalName
```
public SimComponent getComponentByHierarchicalName(String hierarchicalName)
```
    Convenience method to get a component by its name given a fully qualified name such as "container1.sub1.myMachine".
  - print
```
public void print(String message)
```
    Triggers a print event for the given message of category "INFO".
    
    Parameters:
    
    message - The message to print.
    
    See Also:
    
    print(MsgCategory, String)
  - print
```
public void print(MsgCategory category,
                  String message)
```
    Triggers a print event of the given category. If an appropriate listener is installed, this should produce an output of message.
    
    Parameters:
    
    message - The message to print.
  - print
```
public void print(MsgCategory category,
                  Object... params)
```
    Triggers a print event of the given category. If an appropriate listener is installed, this should produce an output of message.
  - print
```
protected void print(SimPrintMessage e)
```
    Prints a certain SimPrintMessage by passing it to the registered print listeners.
  - trace
```
public void trace(Object... params)
```
    Produces a trace message (if there are any print listeners such as TraceFileProducer are registered that do something with such messages). A trace message consists of the simulation time and all parameters converted to Strings (separated by tabs).
    
    Specified by:
    
    trace in interface SimOperations
    
    Parameters:
    
    params - The components of the trace message.
    
    See Also:
    
    trace(Object...)
  - isTraceEnabled
```
public boolean isTraceEnabled()
```
    Description copied from interface: SimOperations
    
    Returns true is trace messages should be produced.
    
    Specified by:
    
    isTraceEnabled in interface SimOperations
    
    Returns:
    
    Whether or not trace messages are to be produced.
    
    See Also:
    
    isTraceEnabled()
  - getPrintLevel
```
public MsgCategory getPrintLevel()
```
    Returns:
    
    The current maximum print message category.
  - setPrintLevel
```
public void setPrintLevel(MsgCategory printLevel)
```
    Sets the maximum print message category to be forwared to the print listeners. If this is set to e.g. INFO, then only messages of the categories ERROR, WARN and INFO are forwared to
    
    Parameters:
    
    printLevel -
  - printFmt
```
public void printFmt(MsgCategory category,
                     String messageFormatString,
                     Object... params)
```
    Triggers a print event of the given category with the message produced by a Java format String. If an appropriate listener is installed, this produces a message defined by the format string messageFormatString (used with the arguments given in params).
  - printFmt
```
public void printFmt(String messageFormatString,
                     Object... params)
```
    Same as printFmt(MsgCategory, String, Object...), but defaulting to category INFO.
  - createEventQueue
```
protected EventQueue createEventQueue()
```
    Factory method to create a new event queue.
    
    Returns:
    
    The event queue to use in this simulation.
  - setSimulationLength
```
public void setSimulationLength(double simulationLength)
```
    Sets the maximum simulation time. A value of 0.0 means no such limit.
  - getSimulationLength
```
public double getSimulationLength()
```
    Returns:
    
    The maximum simulation time; a value of 0.0 means no such limit.
  - getRndStreamFactory
```
public RandomFactory getRndStreamFactory()
```
    Returns:
    
    The RandomFactory used to create random number streams.
  - setRndStreamFactory
```
public void setRndStreamFactory(RandomFactory rndStreamFactory)
```
    Sets the random factory to use to create random number streams for stochastic simulations.
  - initRndGen
```
public <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 this simulation.
    
    Specified by:
    
    initRndGen in interface SimOperations
    
    See Also:
    
    initRndGen(DblSequence, String)
  - initRndGen
```
public 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 this simulation.
    
    Specified by:
    
    initRndGen in interface SimOperations
    
    See Also:
    
    initRndGen(String)
  - getName
```
public String getName()
```
    Returns:
    
    The name of this simulation.
  - setName
```
public void setName(String name)
```
    Sets a name for this simulation.
  - getRootComponent
```
public SimComponentRoot getRootComponent()
```
    Specified by:
    
    getRootComponent in interface SimOperations
    
    Returns:
    
    The root component of all SimComponents contained in the simulation.
  - getInitialSimTime
```
public double getInitialSimTime()
```
  - setInitialSimTime
```
public void setInitialSimTime(double initialSimTime)
```
    Sets the initial value of the simulation clock.
  - getInitialEventPriority
```
public int getInitialEventPriority()
```
  - setInitialEventPriority
```
public void setInitialEventPriority(int initialEventPriority)
```
    Sets the initial priority value (default=0, i.e., SimEvent.EVENT_PRIO_NORMAL).
  - getSimTimeStartInstant
```
public Instant getSimTimeStartInstant()
```
    Returns the Instant corresponding to the initial simulation time.
    
    See Also:
    
    setSimTimeStartInstant(Instant), getInitialSimTime()
  - setSimTimeStartInstant
```
public void setSimTimeStartInstant(Instant simTimeStartInstant)
```
    Sets the Instant corresponding to the a simulation time of 0. The default setting is to use the beginning of the current year.
    The Instant will be truncated to milliseconds, so any nano-second part will be cleared.
    
    See Also:
    
    simTimeToInstant(double)
  - getSimTimeToMillisFactor
```
public long getSimTimeToMillisFactor()
```
    Returns the factor used to convert the (double-valued) simulation time to milli-seconds since getSimTimeStartInstant().
    
    See Also:
    
    setSimTimeToMillisFactor(long)
  - getStatsResetTime
```
public double getStatsResetTime()
```
    Returns the statistics reset time.
  - setStatsResetTime
```
public void setStatsResetTime(double statsResetTime)
```
    Sets the time when to perform a statistics reset. The value set here will only have an effect before the simulation is started.
    
    Parameters:
    
    statsResetTime - The new statistics reset time.
  - getLocale
```
public Locale getLocale()
```
    Returns the currently set Locale, i.e., language and region.
  - setLocale
```
public void setLocale(Locale locale)
```
    Sets the current Locale.
  - getZoneId
```
public ZoneId getZoneId()
```
  - setZoneId
```
public void setZoneId(ZoneId zone)
```
    Sets the current time zone (used by simTimeToLocalDateTime().
  - message
```
public String message(Enum<?> key)
```
  - message
```
public String message(String keyName)
```
  - formattedMessage
```
public String formattedMessage(Enum<?> key,
                               Object... params)
```
  - getErrorHandler
```
public Simulation.ErrorHandler getErrorHandler()
```
  - setErrorHandler
```
public void setErrorHandler(Simulation.ErrorHandler errorHandler)
```
  - setSimTimeToMillisFactor
```
public void setSimTimeToMillisFactor(long simTimeToMillisFactor)
```
    Sets the factor used to convert the (double-valued) simulation time to milli-seconds since getSimTimeStartInstant(). The default value is 60*1000=60000, assuming simulation time to be in minutes.
    
    See Also:
    
    simTimeToInstant(double)
  - setSimTimeToMillisFactor
```
public void setSimTimeToMillisFactor(TemporalUnit u)
```
    Specifies the time unit of the (double-valued) simulation time. The default value is ChronoUnit.MINUTES.
    
    See Also:
    
    simTimeToInstant(double), setSimTimeToMillisFactor(long)
  - continueSim
```
public boolean continueSim()
```
  - runInSimThread
```
public void runInSimThread(Runnable r)
```
  - runInSimThread
```
public void runInSimThread(SimProcessUtil.SimAction a)
```
  - valueStoreImpl
```
public ValueStore valueStoreImpl()
```
    Description copied from interface: ValueStore
    
    Returns the implementation to use for adding ValueStore functionality.
    
    Specified by:
    
    valueStoreImpl in interface ValueStore
  - getSim
```
public Simulation getSim()
```
    Specified by:
    
    getSim in interface ProcessActivator
    
    Specified by:
    
    getSim in interface SimOperations
  - numRunnableProcesses
```
public int numRunnableProcesses()
```
  - runnableProcesses
```
public List<SimProcess<?>> runnableProcesses()
```
  - getMainProcessActions
```
public SimProcessUtil.SimAction getMainProcessActions()
```
  - setMainProcessActions
```
public void setMainProcessActions(SimProcessUtil.SimRunnable r)
```
  - setMainProcessActions
```
public void setMainProcessActions(SimProcessUtil.SimAction mainProcessActions)
```

Modifier and Type	Field	Description
`static String`	`QUEUE_IMPL_KEY`
`static Class<? extends EventQueue>`	`queueImpl`
`static String`	`SIM_TIME`

Class Simulation

Nested Class Summary

Nested classes/interfaces inherited from interface jasima.core.simulation.util.SimOperations

Field Summary

Fields inherited from interface jasima.core.util.observer.Notifier

Fields inherited from interface jasima.core.simulation.util.ProcessActivator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface jasima.core.util.observer.Notifier

Methods inherited from interface jasima.core.simulation.util.ProcessActivator

Methods inherited from interface jasima.core.simulation.util.SimOperations

Methods inherited from interface jasima.core.util.ValueStore

Field Detail

SIM_TIME

QUEUE_IMPL_KEY

queueImpl

Constructor Detail

Simulation

Method Detail

notifierImpl

of

of

of

of

of

of

addPrintListener

removePrintListener

numPrintListener

printListener

init

initComponentTree

run

runEventHandler

defaultErrorHandler

beforeRun

resetStats

afterRun

done

performRun

performRunAsync

performRunAsync

unschedule

schedule

schedulePeriodically

schedulePeriodically

scheduleProcess

scheduleProcess

end

isEndRequested

pause

unpause

simTime

clock

simTimeToLocalDateTime

simTimeToLocalDateTime

simTimeToLocalDateTime

simTimeToInstant

simTimeToDuration

toSimTime

toSimTime

toSimTime

currentPrio

currentEvent

currentProcess

state

observableState

numEventsProcessed

numAppEvents

numEvents

scheduledEvents

produceResults

addResult

activateEntity

getComponentByHierarchicalName

print

print

print

print