simulation.simulators

Interface IAtomicSimulator

All Superinterfaces:

Comparable<INamed>, INamed, ISimulator

All Known Subinterfaces:

ICoordinator

All Known Implementing Classes:

AtomicSimulator, Coordinator

public interface IAtomicSimulator
extends ISimulator

Atomic Simulator interface.

Author:

cmascart

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.
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 parent) Setter on the parent simulator.
void	setRootParent(IAtomicSimulator rootParent) Setter on the top level parent simulator.

Methods inherited from interface simulation.simulators.ISimulator

deltFunc, deltFunc, initialize, initialize, model, simInject, simulate, timeAdvance, tL, tN

Methods inherited from interface util.INamed

name

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

outputMessage

Message outputMessage()

Getter on model's output Message.

Returns:

Message on model's output.

inputMessage

Message inputMessage()

Getter on model's input Message.

Returns:

Message on model's input.

parent

IAtomicSimulator parent()

Getter on the parent simulator in case of coupled model.

Returns:

The parent simulator.

setParent

void setParent(IAtomicSimulator parent)

Setter on the parent simulator.

Parameters:

parent - The new parent simulator.

rootParent

IAtomicSimulator rootParent()

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

Returns:

The top level root parent simulator.

setRootParent

void setRootParent(IAtomicSimulator rootParent)

Setter on the top level parent simulator.

Parameters:

rootParent - The new top level root parent.

setModelsToSimulate

void setModelsToSimulate(HashMap<INamed,IAtomicSimulator> modelsToSimulate)

Setter on list of models to simulate into this.

Parameters:

modelsToSimulate - Models to simulate.

scheduler

IScheduler scheduler()

Getter on the simulator's Scheduler.

Returns:

The Scheduler.

addInInputMessage

void addInInputMessage(IContent content)

Add a content into input message.

Parameters:

content - The content to add into input message.

addInOutputMessage

void addInOutputMessage(IContent content)

Add a content into output message.

Parameters:

content - The content to add into output message.

addImmDelt

void addImmDelt(IAtomicSimulator atomicSimulator)

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

Parameters:

atomicSimulator - The simulator to add.

addPair

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

Add a coupling information.

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.

nextTN

Double nextTN()

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

Returns:

Internal general next event occurrence date.

computeOutput

void computeOutput(Double t)

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

Parameters:

t - The date to which compute output message.

routeOutMessages

void routeOutMessages()

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

convertMsg

MultiMap<INamed,IContent> convertMsg(Message x)

Convert a message into a MultiMap.

Parameters:

x - The message to convert.

Returns:

The converted message.