SSJ  3.3.1
Stochastic Simulation in Java
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Simulator Class Reference

Represents the executive of a discrete-event simulator. More...

Collaboration diagram for Simulator:
[legend]

Public Member Functions

 Simulator ()
 Constructs a new simulator using a splay tree for the event list.
 
 Simulator (EventList eventList)
 Constructs a new simulator using eventList for the event list.
 
double time ()
 Returns the current value of the simulation clock. More...
 
void init ()
 Reinitializes the simulation executive by clearing up the event list, and resetting the simulation clock to zero.
 
void init (EventList evlist)
 Same as init, but also sets evlist as the event list to be used. More...
 
EventList getEventList ()
 Gets the currently used event list. More...
 
boolean isSimulating ()
 Determines if this simulator is currently running, i.e., executing scheduled events.
 
boolean isStopped ()
 Determines if this simulator was stopped by an event. More...
 
void start ()
 Starts the simulation executive. More...
 
void stop ()
 Tells the simulation executive to stop as soon as it takes control, and to return control to the program that called start. More...
 
ContinuousState continuousState ()
 Returns the current state of continuous variables being integrated during the simulation. More...
 

Static Public Member Functions

Static methods
static Simulator getDefaultSimulator ()
 Returns the default simulator instance used by the deprecated class Sim. More...
 

Static Public Attributes

static Simulator defaultSimulator = null
 Represents the default simulator being used by the class Sim, and the no-argument constructor of Event. More...
 

Protected Member Functions

Event removeFirstEvent ()
 Removes the first event from the event list and sets the simulation clock to its event time. More...
 

Protected Attributes

double currentTime = 0.0
 
EventList eventList
 
boolean stopped = true
 
boolean simulating = false
 
ContinuousState continuousState = null
 

Detailed Description

Represents the executive of a discrete-event simulator.

This class maintains a simulation clock, an event list, and starts executing the events in the appropriate order. Its methods permit one to start, stop, and (re)initialize the simulation, and read the simulation clock.

Usually, a simulation program uses a single simulation clock which is represented by an instance of this class. For more convenience and compatibility, this class therefore provides a mechanism to construct and return a default simulator which is used when an event is constructed without an explicit reference to a simulator, and when the simulator is accessed through the Sim class.

Note that this class is NOT thread-safe. Consequently, if a simulation program uses multiple threads, it should acquire a lock on a simulator (using a synchronized block) before accessing its state. Note however, that one can launch many simulations in parallel with as many threads, as long as each thread has its own Simulator.

Member Function Documentation

◆ continuousState()

ContinuousState continuousState ( )

Returns the current state of continuous variables being integrated during the simulation.

This state is used by the Continuous class when performing simulation of continuous variables; it defaults to an empty state, which is initialized only when this method is called.

Returns
continuousState field

◆ getDefaultSimulator()

static Simulator getDefaultSimulator ( )
static

Returns the default simulator instance used by the deprecated class Sim.

If this simulator does not exist yet, it is constructed using the no-argument constructor of this class. One can specify a different default simulator by setting the defaultSimulator field directly.

◆ getEventList()

EventList getEventList ( )

Gets the currently used event list.

Returns
the currently used event list

◆ init()

void init ( EventList  evlist)

Same as init, but also sets evlist as the event list to be used.

For example, init(new DoublyLinked()) initializes the simulator with a doubly linked linear structure umontreal.ssj.simevents.eventlist.DoublyLinked for the event list. Note that this method will clear the event list, so any existing events in evlist will be removed.

To initialize the simulator with a non-empty event list, one can extend the class Simulator and define his own initialization method.

Parameters
evlistselected event list implementation

◆ isStopped()

boolean isStopped ( )

Determines if this simulator was stopped by an event.

The simulator may still be processing the event which has called the stop method; in this case, isSimulating returns true.

◆ removeFirstEvent()

Event removeFirstEvent ( )
protected

Removes the first event from the event list and sets the simulation clock to its event time.

Returns
the first planned event, or null if there is no such event

◆ start()

void start ( )

Starts the simulation executive.

There must be at least one Event in the event list when this method is called.

◆ stop()

void stop ( )

Tells the simulation executive to stop as soon as it takes control, and to return control to the program that called start.

This program will then continue executing from the instructions right after its call to start(.) If an Event is currently executing (and this event has just called stop ), the executive will take control when the event terminates its execution.

◆ time()

double time ( )

Returns the current value of the simulation clock.

Returns
the current simulation time

Member Data Documentation

◆ defaultSimulator

Simulator defaultSimulator = null
static

Represents the default simulator being used by the class Sim, and the no-argument constructor of Event.

This simulator is usually obtained with the getDefaultSimulator method, which initializes it if needed. But it might also be initialized differently, e.g., if process-driven simulation is required.


The documentation for this class was generated from the following file: