simulation.simulators

Class AtomicSimulator

java.lang.Object

simulation.simulators.Simulator

simulation.simulators.AtomicSimulator

All Implemented Interfaces:

Comparable<INamed>, IAtomicSimulator, ISimulator, INamed

Direct Known Subclasses:

Coordinator

public class AtomicSimulator
extends Simulator
implements IAtomicSimulator

Simulator made for models coupled inside a coupling model.

An instance of this class (and not of a child of this class) is destined to manage only atomic models (AtomicDevs), as for its mother class Simulator. This class however acknowledges the existence of other models (contrary to the mother class).

This kind of simulator should only be used in coordination with a Coordinator for managing the coupling and event parts.

Author:

cmascart

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AtomicSimulator.AtomicSimulatorFactory The factory class of the AtomicSimulator.

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

Simulator.SimulatorFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected HashSet<ICoordinator>	_coordinators The set of sub coordinators of this simulator.
protected MultiMap<Map.Entry<INamed,Port>,Map.Entry<INamed,Port>>	_couplingInfo Data structure that represents the coupling between internal models.
protected static Set<IAtomicSimulator>	_IMM_COMPUTE_O The set of models emitting an output at the time of next event.
protected static Set<IAtomicSimulator>	_IMM_DELTFUNC The set of models making a transition at the time of next event.
protected Message	_inputMessage Model input message.
protected HashMap<INamed,IAtomicSimulator>	_modelsToSimulate A collection of simulators associated with their model's name.
protected Message	_outputMessage Model output message.
protected IAtomicSimulator	_parent Parent simulator if it exists, that is to say if the current simulator isn't the top level simulator.
protected IAtomicSimulator	_rootParent Top level parent simulator if it exists, that is to say if the current simulator isn't the top level simulator.
static IScheduler	_scheduler Simulation scheduler, managing the future events.
protected HashSet<IAtomicSimulator>	_simulators The set of subcomponents of this simulator.

Fields inherited from class simulation.simulators.Simulator

_model, _name, _tL, _tN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AtomicSimulator(IDevs model, IAtomicSimulator parent) Specific constructor that sets the model to simulate and the parent simulator.
protected	AtomicSimulator(IDevs model, IAtomicSimulator parent, IScheduler scheduler) Specific constructor that sets the model to simulate, the parent simulator and the simulation scheduler.

Method Summary

Modifier and Type	Method and Description
void	addImmDelt(IAtomicSimulator atomicSimulator) Add a simulator to those who may execute a transition function.
void	addInInputMessage(IContent content) Add a content into input message.
void	addInOutputMessage(IContent content) Add a content into output message.
void	addPair(Map.Entry<INamed,Port> cSender, Map.Entry<INamed,Port> cReceiver) Add a coupling information.
void	computeOutput(Double t) Compute model's output message depending on it's state at a given date.
MultiMap<INamed,IContent>	convertMsg(Message x) Convert a message into a MultiMap.
void	deltFunc(Double t) Wrapper for model transition functions.
void	deltFunc(Double t, Message x) Wrapper for model transition functions.
Message	inputMessage() Getter on model's input Message.
Double	nextTN() Return the simulator real next event occurrence date. considering all internal model in case of coupled model.
Message	outputMessage() Getter on model's output Message.
IAtomicSimulator	parent() Getter on the parent simulator in case of coupled model.
IAtomicSimulator	rootParent() Getter on the top level parent simulator.
void	routeOutMessages() Route messages into the coupled model from internal models output to their receivers.
IScheduler	scheduler() Getter on the simulator's Scheduler.
void	setModelsToSimulate(HashMap<INamed,IAtomicSimulator> modelsToSimulate) Setter on list of models to simulate into this.
void	setParent(IAtomicSimulator p) Setter on the parent simulator.
void	setRootParent(IAtomicSimulator rp) Setter on the top level parent simulator.
void	timeAdvance(Double t) Advance the time of the atomic simulator.

Methods inherited from class simulation.simulators.Simulator

compareTo, initialize, initialize, model, name, simInject, simulate, 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.ISimulator

initialize, initialize, model, simInject, simulate, tL, tN

Methods inherited from interface util.INamed

name

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

_inputMessage

protected Message _inputMessage

Model input message. Cleared after each transition.

_outputMessage

protected Message _outputMessage

Model output message. Cleared after each internal transition.

_parent

protected IAtomicSimulator _parent

Parent simulator if it exists, that is to say if the current simulator isn't the top level simulator.

_rootParent

protected IAtomicSimulator _rootParent

Top level parent simulator if it exists, that is to say if the current simulator isn't the top level simulator.

_modelsToSimulate

protected HashMap<INamed,IAtomicSimulator> _modelsToSimulate

A collection of simulators associated with their model's name.

_couplingInfo

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

Data structure that represents the coupling between internal models.

_simulators

protected HashSet<IAtomicSimulator> _simulators

The set of subcomponents of this simulator. If this simulator's model is an atomic model, the set is empty.

_coordinators

protected HashSet<ICoordinator> _coordinators

The set of sub coordinators of this simulator. If this simulator's model is an atomic model, the set is empty.

_IMM_DELTFUNC

protected static Set<IAtomicSimulator> _IMM_DELTFUNC

The set of models making a transition at the time of next event. Cleared when the time of next event changes.

_IMM_COMPUTE_O

protected static Set<IAtomicSimulator> _IMM_COMPUTE_O

The set of models emitting an output at the time of next event. Cleared when the time of next event changes.

_scheduler

public static IScheduler _scheduler

Simulation scheduler, managing the future events.

Constructor Detail

AtomicSimulator

protected AtomicSimulator(IDevs model,
                          IAtomicSimulator parent,
                          IScheduler scheduler)

Specific constructor that sets the model to simulate, the parent simulator and the simulation scheduler.

Parameters:

model - The model to simulate.

parent - The parent simulator.

scheduler - The new simulation scheduler.

AtomicSimulator

protected AtomicSimulator(IDevs model,
                          IAtomicSimulator parent)

Specific constructor that sets the model to simulate and the parent simulator.

Parameters:

model - The model to simulate.

parent - The parent simulator.

Method Detail

outputMessage

public Message outputMessage()

Getter on model's output Message.

Specified by:

outputMessage in interface IAtomicSimulator

Returns:

Message on model's output.

inputMessage

public Message inputMessage()

Getter on model's input Message.

Specified by:

inputMessage in interface IAtomicSimulator

Returns:

Message on model's input.

parent

public IAtomicSimulator parent()

Getter on the parent simulator in case of coupled model.

Specified by:

parent in interface IAtomicSimulator

Returns:

The parent simulator.

setParent

public void setParent(IAtomicSimulator p)

Setter on the parent simulator.

Specified by:

setParent in interface IAtomicSimulator

Parameters:

p - The new parent simulator.

rootParent

public IAtomicSimulator rootParent()

Getter on the top level parent simulator. That is to say the root in the simulator tree.

Specified by:

rootParent in interface IAtomicSimulator

Returns:

The top level root parent simulator.

setRootParent

public void setRootParent(IAtomicSimulator rp)

Setter on the top level parent simulator.

Specified by:

setRootParent in interface IAtomicSimulator

Parameters:

rp - The new top level root parent.

setModelsToSimulate

public void setModelsToSimulate(HashMap<INamed,IAtomicSimulator> modelsToSimulate)

Setter on list of models to simulate into this.

Specified by:

setModelsToSimulate in interface IAtomicSimulator

Parameters:

modelsToSimulate - Models to simulate.

scheduler

public IScheduler scheduler()

Getter on the simulator's Scheduler.

Specified by:

scheduler in interface IAtomicSimulator

Returns:

The Scheduler.

addPair

public void addPair(Map.Entry<INamed,Port> cSender,
                    Map.Entry<INamed,Port> cReceiver)

Add a coupling information.

Specified by:

addPair in interface IAtomicSimulator

Parameters:

cSender - Pair of strings that represents association between a model and a port and that sends message to the receiver.

cReceiver - Pair of strings that represents association between a model and a port and that receives a message from the sender.

computeOutput

public void computeOutput(Double t)

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

Specified by:

computeOutput in interface IAtomicSimulator

Parameters:

t - The date to which compute output message.

addInInputMessage

public void addInInputMessage(IContent content)

Add a content into input message.

Specified by:

addInInputMessage in interface IAtomicSimulator

Parameters:

content - The content to add into input message.

addInOutputMessage

public void addInOutputMessage(IContent content)

Add a content into output message.

Specified by:

addInOutputMessage in interface IAtomicSimulator

Parameters:

content - The content to add into output message.

routeOutMessages

public void routeOutMessages()

Route messages into the coupled model from internal models output to their receivers.

Specified by:

routeOutMessages in interface IAtomicSimulator

convertMsg

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

Convert a message into a MultiMap.

Specified by:

convertMsg in interface IAtomicSimulator

Parameters:

x - The message to convert.

Returns:

The converted message.

addImmDelt

public void addImmDelt(IAtomicSimulator atomicSimulator)

Add a simulator to those who may execute a transition function.

Specified by:

addImmDelt in interface IAtomicSimulator

Parameters:

atomicSimulator - The simulator to add.

deltFunc

public void deltFunc(Double t,
                     Message x)

Wrapper for model transition functions.

Specified by:

deltFunc in interface ISimulator

Overrides:

deltFunc in class Simulator

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

Overrides:

deltFunc in class Simulator

Parameters:

t - Event happen date.

timeAdvance

public void timeAdvance(Double t)

Advance the time of the atomic simulator. Add to the set of future events the one forecasted for this atomic simulator, while removing the old forecasted events that no longer exist.

Specified by:

timeAdvance in interface ISimulator

Overrides:

timeAdvance in class Simulator

Parameters:

t - the new total simulation time.

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

Returns:

Internal general next event occurrence date.