umontreal.ssj.simevents.Sim Class Reference

This static class contains the executive of a discrete-event simulation. More...

Static Public Member Functions
static double	time ()
	Returns the current value of the simulation clock.
static void	init ()
	Reinitializes the simulation executive by clearing up the event list, and resetting the simulation clock to zero.
static void	init (EventList evlist)
	Same as init, but also chooses evlist as the event list to be used.
static EventList	getEventList ()
	Gets the currently used event list.
static void	start ()
	Starts the simulation executive.
static void	stop ()
	Tells the simulation executive to stop as soon as it takes control, and to return control to the program that called start.

Static Protected Member Functions
static Event	removeFirstEvent ()
	This method is used by the package umontreal.ssj.simprocs; it should not be used directly by a simulation program.

Detailed Description

This static class contains the executive of a discrete-event simulation.

It maintains the simulation clock 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.

Starting from SSJ-2.0, the Sim class now uses the default simulator returned by the getDefaultSimulator() method in the Simulator class. Although the Sim class is perfectly adequate for simple simulations, the Simulator class is more general and supports more functionnalities. For example, if one needs to have more than one simulation clock and event list, one will have to use the Simulator class instead of the simpler Sim class.

Definition at line 48 of file Sim.java.

Member Function Documentation

getEventList()

EventList umontreal.ssj.simevents.Sim.getEventList ( )

static

Gets the currently used event list.

Returns

the currently used event list

Definition at line 94 of file Sim.java.

init() [1/2]

void umontreal.ssj.simevents.Sim.init ( )

static

Reinitializes the simulation executive by clearing up the event list, and resetting the simulation clock to zero.

This method must not be used to initialize process-driven simulation; umontreal.ssj.simprocs.SimProcess.init must be used instead.

Definition at line 69 of file Sim.java.

init() [2/2]

void umontreal.ssj.simevents.Sim.init ( EventList evlist )

static

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

For example, calling init(new DoublyLinked()) initializes the simulation with a doubly linked linear structure for the event list. This method must not be used to initialize process-driven simulation; umontreal.ssj.simprocs.DSOLProcessSimulator(init)  (EventList) or
umontreal.ssj.simprocs.ThreadProcessSimulator(init)  (EventList) must be used instead.

Parameters

evlist

selected event list implementation

Definition at line 85 of file Sim.java.

removeFirstEvent()

Event umontreal.ssj.simevents.Sim.removeFirstEvent ( )

staticprotected

This method is used by the package umontreal.ssj.simprocs; it should not be used directly by a simulation program.

It 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

Definition at line 105 of file Sim.java.

start()

void umontreal.ssj.simevents.Sim.start ( )

static

Starts the simulation executive.

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

Definition at line 113 of file Sim.java.

stop()

void umontreal.ssj.simevents.Sim.stop ( )

static

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 Sim.start. If an Event is currently executing (and this event has just called Sim.stop), the executive will take control when the event terminates its execution.

Definition at line 125 of file Sim.java.

time()

double umontreal.ssj.simevents.Sim.time ( )

static

Returns the current value of the simulation clock.

Returns

the current simulation time

Definition at line 59 of file Sim.java.

---

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

• src/main/java/umontreal/ssj/simevents/Sim.java