ptolemy.domains.fmi.kernel

Class FMIDirector

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.actor.Director

ptolemy.domains.fmi.kernel.FMIDirector

All Implemented Interfaces:

java.lang.Cloneable, Executable, Initializable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class FMIDirector
extends Director

Execute the FMI Master Algorithm.

Since:

Ptolemy II 10.0

Version:

$Id: FMIDirector.java 70349 2014-10-12 22:45:57Z cxh $

Author:

Christopher Brooks, Based on the DoNothingDirector by Edward A. Lee

Accepted Rating:

Red (cxh)

Proposed Rating:

Red (eal)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.util.NamedObj

NamedObj.ContainedObjectsIterator

Field Summary

Fields inherited from class ptolemy.actor.Director

_actorsFinishedExecution, _aspectForActor, _aspectsPresent, _defaultMicrostep, _executionAspects, _finishRequested, _initializables, _nextScheduleTime, _stopRequested, _tokenSentToCommunicationAspect, _zeroTime, localClock, startTime, stopTime

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

Constructors

Constructor and Description
FMIDirector(CompositeEntity container, java.lang.String name) Construct a director with the given container and name.

Method Summary

Modifier and Type	Method and Description
void	addInitializable(Initializable initializable) Add the specified object to the set of objects whose preinitialize(), initialize(), and wrapup() methods should be invoked upon invocation of the corresponding methods of this object.
void	fire() Execute the FMI Master Algorithm.
double	getStopTime() Return the stop time, which is always 1.0.
void	initialize() Do nothing except call the super class.
boolean	postfire() Do nothing except call the super class.
boolean	prefire() Do nothing except call the super class.
void	preinitialize() Do nothing except call the super class.
boolean	transferInputs(IOPort port) Transfer data from an input port of the container to the ports it is connected to on the inside.
boolean	transferOutputs(IOPort port) Transfer data from an output port of the container to the ports it is connected to on the outside.

Methods inherited from class ptolemy.actor.Director

_actorFinished, _consultTimeRegulators, _description, _isEmbedded, _isTopLevel, _schedule, _transferInputs, _transferOutputs, attributeChanged, clone, createSchedule, defaultDependency, delayDependency, finish, fireAt, fireAt, fireAt, fireAtCurrentTime, fireContainerAt, fireContainerAt, getCausalityInterface, getCurrentTime, getDeadline, getEnvironmentTime, getErrorTolerance, getExecutionAspect, getGlobalTime, getModelNextIterationTime, getModelStartTime, getModelStopTime, getModelTime, getNextIterationTime, getStartTime, getTimeResolution, implementsStrictActorSemantics, initialize, invalidateResolvedTypes, invalidateSchedule, isEmbedded, isFireFunctional, isStopRequested, isStrict, iterate, mutexLockObject, newReceiver, notifyTokenSentToCommunicationAspect, preinitialize, removeInitializable, requestInitialization, resume, resumeActor, scheduleContainedActors, setContainer, setCurrentTime, setEmbedded, setModelTime, setTimeResolution, stop, stopFire, suggestedModalModelDirectors, supportMultirateFiring, suspend, terminate, transferOutputs, wrapup

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, setName, updateContent

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getElementName, getFullName, getModelErrorHandler, getName, getName, getPrototypeList, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateExistence, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, uniqueName, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Constructor Detail

FMIDirector

public FMIDirector(CompositeEntity container,
                   java.lang.String name)
            throws NameDuplicationException,
                   IllegalActionException

Construct a director with the given container and name.

Parameters:

container - The container.

name - The name of this actor.

Throws:

IllegalActionException - If the entity cannot be contained by the proposed container.

NameDuplicationException - If the container already has an actor with this name.

Method Detail

addInitializable

public void addInitializable(Initializable initializable)

Description copied from class: Director

Add the specified object to the set of objects whose preinitialize(), initialize(), and wrapup() methods should be invoked upon invocation of the corresponding methods of this object.

Specified by:

addInitializable in interface Initializable

Overrides:

addInitializable in class Director

Parameters:

initializable - The object whose methods should be invoked.

See Also:

Director.removeInitializable(Initializable), CompositeActor.addPiggyback(Executable)

fire

public void fire()
          throws IllegalActionException

Execute the FMI Master Algorithm.

Specified by:

fire in interface Executable

Overrides:

fire in class Director

Throws:

IllegalActionException - If the Master Algorithm cannot be executed or if thrown by the super class.

getStopTime

public double getStopTime()
                   throws IllegalActionException

Return the stop time, which is always 1.0.

Overrides:

getStopTime in class Director

Returns:

1.0

Throws:

IllegalActionException - Not thrown in this base class.

initialize

public void initialize()
                throws IllegalActionException

Do nothing except call the super class.

Specified by:

initialize in interface Initializable

Overrides:

initialize in class Director

Throws:

IllegalActionException - If thrown by the super class.

postfire

public boolean postfire()
                 throws IllegalActionException

Do nothing except call the super class.

Specified by:

postfire in interface Executable

Overrides:

postfire in class Director

Returns:

True to continue execution, and false otherwise.

Throws:

IllegalActionException - If thrown by the super class.

prefire

public boolean prefire()
                throws IllegalActionException

Do nothing except call the super class.

Specified by:

prefire in interface Executable

Overrides:

prefire in class Director

Returns:

True.

Throws:

IllegalActionException - If thrown by the super class.

preinitialize

public void preinitialize()
                   throws IllegalActionException

Do nothing except call the super class.

Specified by:

preinitialize in interface Initializable

Overrides:

preinitialize in class Director

Throws:

IllegalActionException - If thrown by the super class.

transferInputs

public boolean transferInputs(IOPort port)

Description copied from class: Director

Transfer data from an input port of the container to the ports it is connected to on the inside. The implementation in this base class transfers at most one token. Derived classes may override this method to transfer a domain-specific number of tokens.

Overrides:

transferInputs in class Director

Parameters:

port - The port to transfer tokens from.

Returns:

True if at least one data token is transferred.

transferOutputs

public boolean transferOutputs(IOPort port)

Description copied from class: Director

Transfer data from an output port of the container to the ports it is connected to on the outside. The implementation in this base class transfers at most one token, but derived classes may transfer more than one token.

Overrides:

transferOutputs in class Director

Parameters:

port - The port to transfer tokens from.

Returns:

True if at least one data token is transferred.