modeling.models

Class Devs

java.lang.Object

modeling.models.Devs

All Implemented Interfaces:

Comparable<INamed>, IDevs, INamed

Direct Known Subclasses:

AtomicDevs, CoupledDevs

public abstract class Devs
extends Object
implements IDevs

A DEVS model representation. A DEVS model can either be a Coupled model (CoupledDevs) or an Atomic model (AtomicDevs), or any user own definition / implementation.

This class gives its children message-exchange abilities, a parent model, a managing simulator and a name.

Author:

cmascart

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Devs.DevsFactory Creates an abstract level for all the children classes of this class.

Field Summary

Fields

Modifier and Type	Field and Description
protected Message	_inputMessage Messages that are on the input.
protected Ports	_inputPorts An HashSet of Ports on the input.
protected String	_name A unique identifier for this DEVS model.
protected Message	_output Messages that are on the output.
protected Ports	_outputPorts An HashSet of Ports on the output.
protected ICoupledDevs	_parent The parent model.
protected ISimulator	_simulator The model's simulator.

Constructor Summary

Constructors

Constructor and Description
Devs(String name) DEVS constructor that takes a string as the name of the instance.

Method Summary

Modifier and Type	Method and Description
void	addInport(String portName) Add an input Port on the model.
void	addOutport(String portName) Add an output Port on the model.
int	compareTo(INamed in)
String	fullName() The name of the model and all its parents.
static <V> Content<V>	makeContent(String p, V value) Build a Content from a Port's name as a String and an Object value.
String	name() The name of this model.
ICoupledDevs	parent() Getter on the parent model.
void	setParent(ICoupledDevs p) Set the parent model which is a ICoupledDevs implementation if it exists.
void	setSimulator(ISimulator si) Setter of the model's simulator.
ISimulator	simulator() Getter on the model's simulator.

Methods inherited from class java.lang.Object

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

Methods inherited from interface modeling.models.IDevs

act, deltcon, deltext, deltint, initialize, lambda, ta

Field Detail

_name

protected String _name

A unique identifier for this DEVS model.

_inputPorts

protected Ports _inputPorts

An HashSet of Ports on the input.

_outputPorts

protected Ports _outputPorts

An HashSet of Ports on the output.

_inputMessage

protected Message _inputMessage

Messages that are on the input.

_output

protected Message _output

Messages that are on the output.

_parent

protected ICoupledDevs _parent

The parent model.

_simulator

protected ISimulator _simulator

The model's simulator.

Constructor Detail

Devs

public Devs(String name)

DEVS constructor that takes a string as the name of the instance.

Parameters:

name - The DEVS's instance name.

Method Detail

name

public String name()

The name of this model. Should be unique in the parent Coupled model's set of components names.

Specified by:

name in interface INamed

Returns:

the name of this model.

setParent

public void setParent(ICoupledDevs p)

Set the parent model which is a ICoupledDevs implementation if it exists.

Specified by:

setParent in interface IDevs

Parameters:

p - the model to set as parent form the current model.

simulator

public ISimulator simulator()

Getter on the model's simulator.

Specified by:

simulator in interface IDevs

Returns:

Model's simulator.

setSimulator

public void setSimulator(ISimulator si)

Setter of the model's simulator.

Specified by:

setSimulator in interface IDevs

Parameters:

si - The simulator to set as the model's simulator.

parent

public ICoupledDevs parent()

Getter on the parent model.

Specified by:

parent in interface IDevs

Returns:

Parent model.

addInport

public void addInport(String portName)

Add an input Port on the model.

Specified by:

addInport in interface IDevs

Parameters:

portName - The name of the new input Port.

addOutport

public void addOutport(String portName)

Add an output Port on the model.

Specified by:

addOutport in interface IDevs

Parameters:

portName - The name of the new output Port.

makeContent

public static <V> Content<V> makeContent(String p,
                                         V value)

Build a Content from a Port's name as a String and an Object value.

Type Parameters:

V - The value class of the content.

Parameters:

p - The Port's name to use as key.

value - A value.

Returns:

A new Content where the String is the key and the Entity is the value.

compareTo

public int compareTo(INamed in)

Specified by:

compareTo in interface Comparable<INamed>

fullName

public String fullName()

Description copied from interface: IDevs

The name of the model and all its parents.

Specified by:

fullName in interface IDevs

Returns:

the name of the model and all its parents, in descending order, all names separated by a point.