modeling.models

Interface IDevs

All Superinterfaces:

Comparable<INamed>, INamed

All Known Subinterfaces:

IAtomicDevs, ICoupledDevs

All Known Implementing Classes:

AtomicDevs, CoupledDevs, Devs, SimpleAtomic, SimpleCoupledModel, SimpleHierarchicalModel

public interface IDevs
extends INamed

An interface for Devs models.

Author:

cmascart

Method Summary

Modifier and Type	Method and Description
default int	act() A getter on the model's ability to output things.
void	addInport(String portName) Add an input Port on the model.
void	addOutport(String portName) Add an output Port on the model.
default void	deltcon(Double e, Message x) The confluent transition function that is called when both internal and external transitions should happen at the exactly same time.
default void	deltext(Double e, Message x) The external transition function that is called when a Message is received from another model.
default void	deltint() The internal transition function.
String	fullName() The name of the model and all its parents.
void	initialize() Initialize the model.
default Message	lambda() DEVS lambda function that make the state becoming the model's output.
ICoupledDevs	parent() A 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() A getter on the model's simulator.
default Double	ta() Return the time advance to the next event's occurrence.

Methods inherited from interface util.INamed

name

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

initialize

void initialize()

Initialize the model.

setParent

void setParent(ICoupledDevs p)

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

Parameters:

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

simulator

ISimulator simulator()

A getter on the model's simulator.

Returns:

the model's simulator.

setSimulator

void setSimulator(ISimulator si)

Setter of the model's simulator.

Parameters:

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

addInport

void addInport(String portName)

Add an input Port on the model.

Parameters:

portName - the name of the new input Port.

addOutport

void addOutport(String portName)

Add an output Port on the model.

Parameters:

portName - the name of the new output Port.

parent

ICoupledDevs parent()

A getter on the parent model.

Returns:

the parent model.

fullName

String fullName()

The name of the model and all its parents.

Returns:

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

deltext

default void deltext(Double e,
                     Message x)

The external transition function that is called when a Message is received from another model.

Parameters:

e - this time correspond to time to wait before the transition happen.

x - this is the message to be sent at the transition.

deltcon

default void deltcon(Double e,
                     Message x)

The confluent transition function that is called when both internal and external transitions should happen at the exactly same time.

Parameters:

e - this time correspond to time to wait before the transition happen.

x - this is the message to be sent at the transition.

deltint

default void deltint()

The internal transition function.

ta

default Double ta()

Return the time advance to the next event's occurrence.

Returns:

the time advance to the next event.

act

default int act()

A getter on the model's ability to output things.

Returns:

the model's ability to output things.

lambda

default Message lambda()

DEVS lambda function that make the state becoming the model's output.

Returns:

an output Message.