modeling.models

Class AtomicDevs

java.lang.Object

modeling.models.Devs

modeling.models.AtomicDevs

All Implemented Interfaces:

Comparable<INamed>, IAtomicDevs, IDevs, INamed

Direct Known Subclasses:

SimpleAtomic

public abstract class AtomicDevs
extends Devs
implements IAtomicDevs

An atomic model as defined in the DEVS formalism.

Atomic models are independent objects which have a state. Their state asynchronously transition, either spontaneously (called an internal event) or when a Message from another atomic model is received (called external event). Messages are sent when an atomic model makes an internal transition.

Author:

cmascart

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AtomicDevs.AtomicFactory

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

Devs.DevsFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected int	_act Define the system ability to output things for the next internal event.
protected String	_phase Current model _phase ("passive","active", ...)
protected double	_sigma Time interval between the last event that happen and and the next internal event occurrence date.

Fields inherited from class modeling.models.Devs

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AtomicDevs(String name) Creates an instance with the passed name.

Method Summary

Modifier and Type	Method and Description
int	act() Getter on the model's ability to output things.
void	AdvanceTime(Double e) Update sigma considering a time advance of e.
void	holdIn(String phase, Double sigma) Update sigma and phase to some specified values.
void	holdInNoOut(String phase, double sigma) Update sigma and phase to the specified value.
Boolean	isPhase(String phase) Check if the specified phase is the model's current phase.
void	passivate() Set model's phase to passive and sigma to infinity.
void	passivateIn(String phase) Set model's phase to a specified value and sigma to infinity.
String	phase() Getter on the model's phase.
void	setSigma(Double sigma) Setter on sigma value.
Double	sigma() Getter on sigma value.
Double	ta() Return the time advance to the next event's occurrence.
String	toString() Serialize instance into a string.

Methods inherited from class modeling.models.Devs

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface modeling.models.IDevs

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

Methods inherited from interface util.INamed

name

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

_sigma

protected double _sigma

Time interval between the last event that happen and and the next internal event occurrence date. Or the time from now to the next internal event occurrence date.

_phase

protected String _phase

Current model _phase ("passive","active", ...)

_act

protected int _act

Define the system ability to output things for the next internal event.

Constructor Detail

AtomicDevs

protected AtomicDevs(String name)

Creates an instance with the passed name.

Parameters:

name - Name of the new AtomicDevs.

Method Detail

phase

public String phase()

Getter on the model's phase.

Returns:

Model's phase as a String.

setSigma

public void setSigma(Double sigma)

Setter on sigma value.

Specified by:

setSigma in interface IAtomicDevs

Parameters:

sigma - New sigma value.

sigma

public Double sigma()

Getter on sigma value.

Specified by:

sigma in interface IAtomicDevs

Returns:

sigma value.

toString

public String toString()

Serialize instance into a string.

Overrides:

toString in class Object

Returns:

Instance string representation.

act

public int act()

Getter on the model's ability to output things.

Specified by:

act in interface IDevs

Returns:

The model's ability to output things.

AdvanceTime

public void AdvanceTime(Double e)

Update sigma considering a time advance of e.

Specified by:

AdvanceTime in interface IAtomicDevs

Parameters:

e - Time advance.

passivateIn

public void passivateIn(String phase)

Set model's phase to a specified value and sigma to infinity.

Specified by:

passivateIn in interface IAtomicDevs

Parameters:

phase - The phase name to set.

passivate

public void passivate()

Set model's phase to passive and sigma to infinity.

Specified by:

passivate in interface IAtomicDevs

holdIn

public void holdIn(String phase,
                   Double sigma)

Update sigma and phase to some specified values. Sets the acting attribute so that an output will be generated at the next internal transition.

Specified by:

holdIn in interface IAtomicDevs

Parameters:

phase - The new phase.

sigma - The new sigma value.

holdInNoOut

public void holdInNoOut(String phase,
                        double sigma)

Update sigma and phase to the specified value. Sets the acting attribute so no output is generated for the next internal transition.

Specified by:

holdInNoOut in interface IAtomicDevs

Parameters:

phase - the new phase.

sigma - the new sigma value.

isPhase

public Boolean isPhase(String phase)

Check if the specified phase is the model's current phase.

Specified by:

isPhase in interface IAtomicDevs

Parameters:

phase - The phase to check.

Returns:

True if the specified phase is the model's current phase, else false.

ta

public Double ta()

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

Specified by:

ta in interface IDevs

Returns:

The time advance to the next event.