simulation.simulators

Interface ICoordinator

All Superinterfaces:

Comparable<INamed>, IAtomicSimulator, INamed, ISimulator

All Known Implementing Classes:

Coordinator

public interface ICoordinator
extends IAtomicSimulator

DEVS coordinator API.

Author:

cmascart

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.
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() A getter to the simulators (no coordinators) under this coordinator.
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.
void	routeInMessages() Route the messages coming from the outside of this model into this model.
Set<IAtomicSimulator>	simulators() The set of all the simulators in use in this simulation and under the level of this coordinator.
void	tellAllRouteInMessages() Tells all sub coordinators to route their input messages.

Methods inherited from interface simulation.simulators.IAtomicSimulator

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

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

internalModelToSim

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.

Returns:

the map of the links.

simulators

Set<IAtomicSimulator> simulators()

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

Returns:

the set of simulators.

coordinators

Set<ICoordinator> coordinators()

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

Returns:

the set of coordinators.

addExtPair

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.

Parameters:

cs - the source of the pairing.

cd - the destination of the pairing.

convertInput

MultiMap<INamed,IContent> convertInput(Message x)

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

Parameters:

x - an input message.

Returns:

a map from models to message contents.

routeInMessages

void routeInMessages()

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

getAllSimulators

Set<IAtomicSimulator> getAllSimulators()

A getter to the simulators (no coordinators) under this coordinator.

Returns:

the simulators.

getAllCoordinators

Set<ICoordinator> getAllCoordinators()

A getter to the coordinators under this coordinator.

Returns:

the coordinators.

addCoordinator

void addCoordinator(ICoupledDevs d)

Add a coordinator to the given coupled model.

Parameters:

d - the coupled model.

tellAllRouteInMessages

void tellAllRouteInMessages()

Tells all sub coordinators to route their input messages.