modeling.models

Class CoupledDevs

java.lang.Object

modeling.models.Devs

modeling.models.CoupledDevs

All Implemented Interfaces:

Comparable<INamed>, ICoupledDevs, IDevs, INamed

Direct Known Subclasses:

SimpleCoupledModel, SimpleHierarchicalModel

public class CoupledDevs
extends Devs
implements ICoupledDevs

A coupled model as defined in the DEVS formalism.

Coupled models are basically sophisticated directed graphs of DEVS models (Atomic or Coupled). The links in the graph represented by the coupled model actually represent a communication link between the two components (either one of the subcomponent of the coupled model or itself). Coupled models are passive objects (as opposed to atomic models, see AtomicDevs), so they only help transmitting in and lambda the messages they receive.

They are managed by Coordinator. A DEVS simulation always begins by the creation of a root coupled model around which a Coordinator will be instantiated.

Author:

cmascart

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CoupledDevs.CoupledFactory The default factory of the CoupledDevs class.

Nested classes/interfaces inherited from class modeling.models.Devs

Devs.DevsFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,IDevs>	_componentDictionary A dictionary that associates DEVS models to a name.
protected Set<IDevs>	_components HashSet of DEVS models (atomic and coupled) that compose this model.
protected MultiMap<Map.Entry<INamed,Port>,Map.Entry<INamed,Port>>	_couplingInfo A MultiMap that contains internal coupling information.

Fields inherited from class modeling.models.Devs

_inputMessage, _inputPorts, _name, _output, _outputPorts, _parent, _simulator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CoupledDevs(String name) Creates a new instance with the passed name.

Method Summary

Modifier and Type	Method and Description
void	add(IDevs iod) 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.
void	addPair(Map.Entry<INamed,Port> cs, Map.Entry<INamed,Port> cd) Add a coupling data represent as a pair of string for the key and a pair of string for the value.
Map<String,IDevs>	componentDictionary() Getter on a dictionary associating all internal models to their names.
Set<IDevs>	components() Getter on the HashSet that contains all internal models.
MultiMap<Map.Entry<INamed,Port>,Map.Entry<INamed,Port>>	couplingInfo() Getter on the MultiMap that contains all coupling relation that is to say associate a pair model/port to another.
void	initialize() Iteratively initializes all subcomponents of this coupled model.
void	setSimulator(ICoordinator simulator) Setter on the model's simulator.
ICoordinator	simulator() Getter on the model's simulator that is actually a Coordinator for coupled models.
String	toString() Generate a String of the instance.

Methods inherited from class modeling.models.Devs

addInport, addOutport, compareTo, fullName, makeContent, name, parent, setParent, setSimulator

Methods inherited from class java.lang.Object

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

Methods inherited from interface modeling.models.IDevs

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

Methods inherited from interface util.INamed

name

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

_components

protected Set<IDevs> _components

HashSet of DEVS models (atomic and coupled) that compose this model.

_componentDictionary

protected Map<String,IDevs> _componentDictionary

A dictionary that associates DEVS models to a name.

_couplingInfo

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

A MultiMap that contains internal coupling information.

Constructor Detail

CoupledDevs

protected CoupledDevs(String name)

Creates a new instance with the passed name.

Parameters:

name - New model's name.

Method Detail

componentDictionary

public Map<String,IDevs> componentDictionary()

Getter on a dictionary associating all internal models to their names.

Specified by:

componentDictionary in interface ICoupledDevs

Returns:

Dictionary that associates all internal models to their name.

simulator

public ICoordinator simulator()

Getter on the model's simulator that is actually a Coordinator for coupled models.

Specified by:

simulator in interface IDevs

Overrides:

simulator in class Devs

Returns:

The model's simulator.

setSimulator

public void setSimulator(ICoordinator simulator)

Setter on the model's simulator.

Specified by:

setSimulator in interface ICoupledDevs

Parameters:

simulator - The new model's simulator.

components

public Set<IDevs> components()

Getter on the HashSet that contains all internal models.

Specified by:

components in interface ICoupledDevs

Returns:

The HashSet that contains all internal models.

couplingInfo

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

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

Specified by:

couplingInfo in interface ICoupledDevs

Returns:

The MultiMap that contains all coupling relation.

add

public void add(IDevs iod)

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

Specified by:

add in interface ICoupledDevs

Parameters:

iod - The new Devs model

addCoupling

public 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.

Specified by:

addCoupling in interface ICoupledDevs

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.

addPair

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

Add a coupling data represent as a pair of string for the key and a pair of string for the value.

Parameters:

cs - Sender data String pair.

cd - Receiver data String pair.

toString

public String toString()

Generate a String of the instance.

Overrides:

toString in class Object

Returns:

Instance string representation.

initialize

public void initialize()

Iteratively initializes all subcomponents of this coupled model.

Specified by:

initialize in interface IDevs