simulation.simulators

Class Simulator

java.lang.Object

simulation.simulators.Simulator

All Implemented Interfaces:

Comparable<INamed>, ISimulator, INamed

Direct Known Subclasses:

AtomicSimulator, SimpleDevs

public abstract class Simulator
extends Object
implements ISimulator

Simulator for only one simple model.

Where the models describe the system and how its components should interact with each others, the simulators are the actual objects making the simulation. They manage the time locally (at which time a given model thinks it is) and globally (the time of the system is the maximum of all its local times).

Author:

cmascart

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Simulator.SimulatorFactory The factory class of all simulators.

Field Summary

Fields

Modifier and Type	Field and Description
protected IDevs	_model Associated model.
protected String	_name A unique identifier for this simulator.
protected Double	_tL Last event occurrence date.
protected Double	_tN Next event occurrence date.

Constructor Summary

Constructors

Constructor and Description
Simulator(IDevs model) Specific constructor that sets the name to "SingleSimulator" and takes a model to simulate.

Method Summary

Modifier and Type	Method and Description
int	compareTo(INamed in)
void	deltFunc(Double t) Wrapper for model transition functions.
void	deltFunc(Double t, Message x) Wrapper for model transition functions.
void	initialize() Initialize associated model, time and dates.
void	initialize(Double currentTime) Initialize associated model, time and dates.
IDevs	model() Getter on the simulated model.
String	name() The name of this simulator, that must be unique among all simulators at the same level and under the same coordinator.
void	simInject(Double e, Message m) Inject an event in the simulation.
void	simulate(Integer itNb) Run the simulation up to a specified iteration count.
void	timeAdvance(Double t) Advance current time to the specified date.
Double	tL() Getter on the last event occurrence date.
Double	tN() Getter on the next event occurrence date.

Methods inherited from class java.lang.Object

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

Field Detail

_name

protected String _name

A unique identifier for this simulator.

_tL

protected Double _tL

Last event occurrence date.

_tN

protected Double _tN

Next event occurrence date.

_model

protected IDevs _model

Associated model.

Constructor Detail

Simulator

public Simulator(IDevs model)

Specific constructor that sets the name to "SingleSimulator" and takes a model to simulate.

Parameters:

model - The model to simulate.

Method Detail

tL

public Double tL()

Getter on the last event occurrence date.

Specified by:

tL in interface ISimulator

Returns:

Last event occurrence date.

tN

public Double tN()

Getter on the next event occurrence date.

Specified by:

tN in interface ISimulator

Returns:

Next event occurrence date.

model

public IDevs model()

Getter on the simulated model.

Specified by:

model in interface ISimulator

Returns:

Simulated model.

name

public String name()

The name of this simulator, that must be unique among all simulators at the same level and under the same coordinator.

Specified by:

name in interface INamed

Returns:

the name of this simulator as a String.

initialize

public void initialize()

Initialize associated model, time and dates.

Specified by:

initialize in interface ISimulator

initialize

public void initialize(Double currentTime)

Initialize associated model, time and dates.

Specified by:

initialize in interface ISimulator

Parameters:

currentTime - Time to next (actually first) event of the simulation.

deltFunc

public void deltFunc(Double t,
                     Message x)

Wrapper for model transition functions.

Specified by:

deltFunc in interface ISimulator

Parameters:

t - Event happen date.

x - Message to be sent.

deltFunc

public void deltFunc(Double t)

Wrapper for model transition functions.

Specified by:

deltFunc in interface ISimulator

Parameters:

t - Event happen date.

simulate

public void simulate(Integer itNb)

Run the simulation up to a specified iteration count.

Specified by:

simulate in interface ISimulator

Parameters:

itNb - The maximum iteration count.

simInject

public void simInject(Double e,
                      Message m)

Inject an event in the simulation.

Specified by:

simInject in interface ISimulator

Parameters:

e - The event happen date.

m - The message to be sent.

timeAdvance

public void timeAdvance(Double t)

Advance current time to the specified date.

Specified by:

timeAdvance in interface ISimulator

Parameters:

t - Time advance.

compareTo

public int compareTo(INamed in)

Specified by:

compareTo in interface Comparable<INamed>