simulation.simulators

Class Coordinator

java.lang.Object

simulation.simulators.Simulator

simulation.simulators.AtomicSimulator

simulation.simulators.Coordinator

All Implemented Interfaces:

Comparable<INamed>, IAtomicSimulator, ICoordinator, ISimulator, INamed

public class Coordinator
extends AtomicSimulator
implements ICoordinator

A Coordinator is like a conductor in a DEVS simulation. This is where the simulation takes place and from where the different transition functions are called at the right moment.

Author:

maitre

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Coordinator.CoordinatorFactory The factory of the Coordinator class.

Nested classes/interfaces inherited from class simulation.simulators.AtomicSimulator

AtomicSimulator.AtomicSimulatorFactory

Nested classes/interfaces inherited from class simulation.simulators.Simulator

Simulator.SimulatorFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected static Factory<IAtomicSimulator>	_coordinatorFactory The factory for coordinators associated with this instance.
protected static Factory<IAtomicSimulator>	_simulatorFactory The factory for simulators associated with this instance.
protected MultiMap<Map.Entry<INamed,Port>,Map.Entry<INamed,Port>>	extCoupInfo The links from outside of this coordinator to itself.
protected Map<INamed,IAtomicSimulator>	internalModelTosim The internal model, that is to say the

Fields inherited from class simulation.simulators.AtomicSimulator

_coordinators, _couplingInfo, _IMM_COMPUTE_O, _IMM_DELTFUNC, _inputMessage, _modelsToSimulate, _outputMessage, _parent, _rootParent, _scheduler, _simulators

Fields inherited from class simulation.simulators.Simulator

_model, _name, _tL, _tN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Coordinator(ICoupledDevs coupledModel, ICoordinator parent) Smaller constructor
protected	Coordinator(ICoupledDevs coupledModel, ICoordinator parent, IScheduler si) Biggest constructor

Method Summary

Modifier and Type	Method and Description
void	addCoordinator(ICoupledDevs d) Add a coordinator to the given coupled model.
void	addExtPair(Map.Entry<INamed,Port> cs, Map.Entry<INamed,Port> cd) Add an external pairing, that is to say a pairing from an external model and its Port to this model and a given Port.
protected void	addSimulator(IAtomicDevs d) Create a simulator and assign it to the atomic model given in parameter.
protected void	buildImminents(Double t) Get all imminent transitions from the scheduler.
void	computeOutput(Double time) Compute model's output message depending on it's state at a given date.
MultiMap<INamed,IContent>	convertInput(Message x) Converts an input to a map of model names to contents.
Set<ICoordinator>	coordinators() The set of coordinators in use in this simulation and under the level of this coordinator.
Set<ICoordinator>	getAllCoordinators() A getter to the coordinators under this coordinator.
Set<IAtomicSimulator>	getAllSimulators() Returns all the simulators in use under this coordinator.
protected void	informCoupling() Creates the coupling information.
void	initialize() Initialize all subcomponents then itself, at time 0.0.
void	initialize(Double currentTime) Initialize this coordinator at a given time.
Map<INamed,IAtomicSimulator>	internalModelToSim() A getter to a dictionary to link the atomic models under the coupled model associated with this coordinator, and their simulator.
ICoupledDevs	model() Getter on the simulated model.
Double	nextTN() Return the simulator real next event occurrence date. considering all internal model in case of coupled model.
protected void	prepareNextTurn() Clears the sets of imminent transitions ans advance the time of this coordinator.
void	routeInMessages() Route the messages coming from the outside of this model into this model.
protected void	routeMessages() Sequentially routes the output messages out of this coordinator, then the input messages inside of this model.
protected void	setSimulators() Every model under the coupled model managed by this coordinator is assigned a Simulator or a Coordinator (depending on the class of the model).
void	simInject(Double e, Message m) Injects a message to this Coordinator.
void	simulate(Integer itNb) Run the simulation up to a specified iteration count.
protected void	simulatorCreated(IAtomicSimulator s, IDevs d) When a simulator or a coordinator has been created by this coordinator, adds it to the memory linked with their assigned model.
Set<IAtomicSimulator>	simulators() The set of all the simulators in use in this simulation and under the level of this coordinator.
void	tellAllRouteInMessages() This method is only called by the root coordinator.
protected void	tellAllRouteOutMessages() This method is only called by the root coordinator.
protected void	tellAllSimsSetModToSim(HashMap<INamed,IAtomicSimulator> inFunc) Assigns models to simulators
protected void	wrapDeltFunc(Double time) A wrapper for calling all the transition functions of all transitioning models.

Methods inherited from class simulation.simulators.AtomicSimulator

addImmDelt, addInInputMessage, addInOutputMessage, addPair, convertMsg, deltFunc, deltFunc, inputMessage, outputMessage, parent, rootParent, routeOutMessages, scheduler, setModelsToSimulate, setParent, setRootParent, timeAdvance

Methods inherited from class simulation.simulators.Simulator

compareTo, name, tL, tN

Methods inherited from class java.lang.Object

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

Methods inherited from interface simulation.simulators.IAtomicSimulator

addImmDelt, addInInputMessage, addInOutputMessage, addPair, convertMsg, inputMessage, outputMessage, parent, rootParent, routeOutMessages, scheduler, setModelsToSimulate, setParent, setRootParent

Methods inherited from interface simulation.simulators.ISimulator

deltFunc, deltFunc, timeAdvance, tL, tN

Methods inherited from interface util.INamed

name

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

internalModelTosim

protected Map<INamed,IAtomicSimulator> internalModelTosim

The internal model, that is to say the

extCoupInfo

protected MultiMap<Map.Entry<INamed,Port>,Map.Entry<INamed,Port>> extCoupInfo

The links from outside of this coordinator to itself.

_simulatorFactory

protected static Factory<IAtomicSimulator> _simulatorFactory

The factory for simulators associated with this instance.

_coordinatorFactory

protected static Factory<IAtomicSimulator> _coordinatorFactory

The factory for coordinators associated with this instance.

Constructor Detail

Coordinator

protected Coordinator(ICoupledDevs coupledModel,
                      ICoordinator parent,
                      IScheduler si)

Biggest constructor

Parameters:

coupledModel - the model

parent - the parent

si - the scheduler

Coordinator

protected Coordinator(ICoupledDevs coupledModel,
                      ICoordinator parent)

Smaller constructor

Parameters:

coupledModel - the model

parent - the parent

Method Detail

internalModelToSim

public Map<INamed,IAtomicSimulator> internalModelToSim()

A getter to a dictionary to link the atomic models under the coupled model associated with this coordinator, and their simulator.

Specified by:

internalModelToSim in interface ICoordinator

Returns:

the map of the links.

setSimulators

protected void setSimulators()

Every model under the coupled model managed by this coordinator is assigned a Simulator or a Coordinator (depending on the class of the model).

tellAllSimsSetModToSim

protected void tellAllSimsSetModToSim(HashMap<INamed,IAtomicSimulator> inFunc)

Assigns models to simulators

Parameters:

inFunc - the dictionnary linking models to simulators.

addCoordinator

public void addCoordinator(ICoupledDevs d)

Add a coordinator to the given coupled model.

Specified by:

addCoordinator in interface ICoordinator

Parameters:

d - the coupled model.

simulatorCreated

protected void simulatorCreated(IAtomicSimulator s,
                                IDevs d)

When a simulator or a coordinator has been created by this coordinator, adds it to the memory linked with their assigned model.

Parameters:

s - the created simulator.

d - the assigned model.

model

public ICoupledDevs model()

Getter on the simulated model.

Specified by:

model in interface ISimulator

Overrides:

model in class Simulator

Returns:

Simulated model.

addExtPair

public void addExtPair(Map.Entry<INamed,Port> cs,
                       Map.Entry<INamed,Port> cd)

Add an external pairing, that is to say a pairing from an external model and its Port to this model and a given Port.

Specified by:

addExtPair in interface ICoordinator

Parameters:

cs - the source of the pairing.

cd - the destination of the pairing.

informCoupling

protected void informCoupling()

Creates the coupling information.

convertInput

public MultiMap<INamed,IContent> convertInput(Message x)

Converts an input to a map of model names to contents.

Specified by:

convertInput in interface ICoordinator

Parameters:

x - an input message.

Returns:

a map from models to message contents.

routeInMessages

public void routeInMessages()

Route the messages coming from the outside of this model into this model.

Specified by:

routeInMessages in interface ICoordinator

getAllCoordinators

public Set<ICoordinator> getAllCoordinators()

A getter to the coordinators under this coordinator.

Specified by:

getAllCoordinators in interface ICoordinator

Returns:

the coordinators.

addSimulator

protected void addSimulator(IAtomicDevs d)

Create a simulator and assign it to the atomic model given in parameter.

Parameters:

d - the atomic model that needs a simulator companion.

simulate

public void simulate(Integer itNb)

Run the simulation up to a specified iteration count.

Specified by:

simulate in interface ISimulator

Overrides:

simulate in class Simulator

Parameters:

itNb - The maximum iteration count.

prepareNextTurn

protected void prepareNextTurn()

Clears the sets of imminent transitions ans advance the time of this coordinator.

nextTN

public Double nextTN()

Return the simulator real next event occurrence date. considering all internal model in case of coupled model.

Specified by:

nextTN in interface IAtomicSimulator

Overrides:

nextTN in class AtomicSimulator

Returns:

Internal general next event occurrence date.

buildImminents

protected void buildImminents(Double t)

Get all imminent transitions from the scheduler.

Parameters:

t - the time of the imminent event.

computeOutput

public void computeOutput(Double time)

Compute model's output message depending on it's state at a given date.

Specified by:

computeOutput in interface IAtomicSimulator

Overrides:

computeOutput in class AtomicSimulator

Parameters:

time - The date to which compute output message.

simInject

public void simInject(Double e,
                      Message m)

Injects a message to this Coordinator. Is used for starting the simulation and for testing / debugging.

Specified by:

simInject in interface ISimulator

Overrides:

simInject in class Simulator

Parameters:

e - the time, since the last event, elapsed to this message.

m - the message to be injected.

routeMessages

protected void routeMessages()

Sequentially routes the output messages out of this coordinator, then the input messages inside of this model.

simulators

public Set<IAtomicSimulator> simulators()

The set of all the simulators in use in this simulation and under the level of this coordinator.

Specified by:

simulators in interface ICoordinator

Returns:

the set of simulators.

coordinators

public Set<ICoordinator> coordinators()

The set of coordinators in use in this simulation and under the level of this coordinator.

Specified by:

coordinators in interface ICoordinator

Returns:

the set of coordinators.

tellAllRouteOutMessages

protected void tellAllRouteOutMessages()

This method is only called by the root coordinator. It tells all the simulators to route their output messages to the highest simulator needed to transmit the message.

tellAllRouteInMessages

public void tellAllRouteInMessages()

This method is only called by the root coordinator. It tells all the simulators to route their input messages down to the right sub-simulator, or to the model if the last is the destination of the message.

Specified by:

tellAllRouteInMessages in interface ICoordinator

wrapDeltFunc

protected void wrapDeltFunc(Double time)

A wrapper for calling all the transition functions of all transitioning models.

Parameters:

time - the time of the event.

initialize

public void initialize()

Initialize all subcomponents then itself, at time 0.0.

Specified by:

initialize in interface ISimulator

Overrides:

initialize in class Simulator

initialize

public void initialize(Double currentTime)

Initialize this coordinator at a given time.

Specified by:

initialize in interface ISimulator

Overrides:

initialize in class Simulator

Parameters:

currentTime - the time of initialization.

getAllSimulators

public Set<IAtomicSimulator> getAllSimulators()

Returns all the simulators in use under this coordinator.

Specified by:

getAllSimulators in interface ICoordinator

Returns:

the simulators.