modeling.models

Interface ICoupledDevs

All Superinterfaces:

Comparable<INamed>, IDevs, INamed

All Known Implementing Classes:

CoupledDevs, SimpleCoupledModel, SimpleHierarchicalModel

public interface ICoupledDevs
extends IDevs

DEVS coupled model API.

Author:

cmascart

Method Summary

Modifier and Type	Method and Description
void	add(IDevs d) Add a new Devs model (atomic or coupled) into the Devs coupled model
void	addCoupling(IDevs src, String p1, IDevs dest, String p2) Add a new coupling relation between internal model or between the coupled model and its internals models.
Map<String,IDevs>	componentDictionary() Getter on a dictionary that associates all internal models to their names.
Set<IDevs>	components() Getter on the unordered_set (~java HashSet) that contains all internal models.
MultiMap<Map.Entry<INamed,Port>,Map.Entry<INamed,Port>>	couplingInfo() Getter on the multi-map that contains all coupling relation that is to say associate a pair model/port to another.
void	setSimulator(ICoordinator sim) Setter on the model's simulator.

Methods inherited from interface modeling.models.IDevs

act, addInport, addOutport, deltcon, deltext, deltint, fullName, initialize, lambda, parent, setParent, setSimulator, simulator, ta

Methods inherited from interface util.INamed

name

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

components

Set<IDevs> components()

Getter on the unordered_set (~java HashSet) that contains all internal models.

Returns:

The unordered_set that contains all internal models.

couplingInfo

MultiMap<Map.Entry<INamed,Port>,Map.Entry<INamed,Port>> couplingInfo()

Getter on the multi-map that contains all coupling relation that is to say associate a pair model/port to another.

Returns:

The multi-map that contains all coupling relation.

setSimulator

void setSimulator(ICoordinator sim)

Setter on the model's simulator.

Parameters:

sim - The new model's simulator.

componentDictionary

Map<String,IDevs> componentDictionary()

Getter on a dictionary that associates all internal models to their names.

Returns:

Dictionary that associates all internal models to their names.

add

void add(IDevs d)

Add a new Devs model (atomic or coupled) into the Devs coupled model

Parameters:

d - The new Devs model

addCoupling

void addCoupling(IDevs src,
                 String p1,
                 IDevs dest,
                 String p2)

Add a new coupling relation between internal model or between the coupled model and its internals models. That is to say connect a models output to another models input or the coupled model input to an internal model input or an internal model output to the coupled model output.

Parameters:

src - The source model (internal model output or coupled model input).

p1 - The source model's port name.

dest - The recipient model (internal model input or coupled model output).

p2 - The recipient model's port name.