Package ptolemy.domains.dde.demo.LocalZeno

Class ListenFeedBackDelay

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity<T>

ptolemy.actor.AtomicActor<TypedIOPort>

ptolemy.actor.TypedAtomicActor

ptolemy.domains.dde.kernel.DDEActor

ptolemy.domains.dde.kernel.FeedBackDelay

ptolemy.domains.dde.demo.LocalZeno.ListenFeedBackDelay

All Implemented Interfaces:

java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

Direct Known Subclasses:

ZenoDelay

public class ListenFeedBackDelay
extends FeedBackDelay

An FeedBackDelay actor that can notify an ExecEventListener of ExecEvents. In particular, the listener will be notified each time the prefire(), postfire() and wrapup() methods of this actor are invoked. Such notification is enabled by adding an ExecEventListener to this actor's listener list via the addListeners() method. Listeners can be removed via the removeListeners() method. ExecEventListeners are currently implemented to serve as conduits between Ptolemy II and the Diva graphical user interface.

Since:

Ptolemy II 0.4

Version:

$Id$

Author:

John S. Davis II

See Also:

NullToken

Pt.AcceptedRating:

Red (yuhong)

Pt.ProposedRating:

Red (davisj)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

Fields inherited from class ptolemy.domains.dde.kernel.FeedBackDelay

delay, input, nullDelay, output, realDelay

Fields inherited from class ptolemy.actor.TypedAtomicActor

_typesValid

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

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	Description
ListenFeedBackDelay()	Construct a ListenFeedBackDelay actor with no container and a name that is an empty string.
ListenFeedBackDelay(CompositeEntity container, java.lang.String name)	Construct a ListenFeedBackDelay actor with the specified container and name.
ListenFeedBackDelay(Workspace workspace)	Construct a ListenFeedBackDelay actor with the specified workspace and no name.

Method Summary

Modifier and Type	Method	Description
boolean	postfire()	Generate an ExecEvent with a state value of 2.
boolean	prefire()	Generate an ExecEvent with a state value of 1, cause the calling thread to sleep for 100 milliseconds and then call the superclass prefire() method.
void	wrapup()	Generate an ExecEvent with a state value of 3.

Methods inherited from class ptolemy.domains.dde.kernel.FeedBackDelay

fire, getDelay, initialize

Methods inherited from class ptolemy.domains.dde.kernel.DDEActor

getNextToken

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Methods inherited from interface ptolemy.actor.Executable

isFireFunctional, isStrict, iterate, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, preinitialize, removeInitializable

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Constructor Detail

ListenFeedBackDelay

public ListenFeedBackDelay()
                    throws IllegalActionException,
                           NameDuplicationException

Construct a ListenFeedBackDelay actor with no container and a name that is an empty string.

Throws:

IllegalActionException

NameDuplicationException

ListenFeedBackDelay

public ListenFeedBackDelay(Workspace workspace)
                    throws IllegalActionException,
                           NameDuplicationException

Construct a ListenFeedBackDelay actor with the specified workspace and no name.

Parameters:

workspace - The workspace for this ListenFeedBackDelay actor.

Throws:

IllegalActionException

NameDuplicationException

ListenFeedBackDelay

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

Construct a ListenFeedBackDelay actor with the specified container and name.

Parameters:

container - The container of this actor.

name - The name of this actor.

Throws:

IllegalActionException - If the constructor of the superclass throws an IllegalActionException.

NameDuplicationException - If the constructor of the superclass throws a NameDuplicationException .

Method Detail

postfire

public boolean postfire()
                 throws IllegalActionException

Generate an ExecEvent with a state value of 2. Return the value of the postfire method of this actor's superclass. Return true if this actor is enabled to call fire(); return false otherwise.

Specified by:

postfire in interface Executable

Overrides:

postfire in class AtomicActor<TypedIOPort>

Returns:

True if this actor is enabled to call fire(); return false otherwise.

Throws:

IllegalActionException - If there is an exception with the thread activity of this method.

prefire

public boolean prefire()
                throws IllegalActionException

Generate an ExecEvent with a state value of 1, cause the calling thread to sleep for 100 milliseconds and then call the superclass prefire() method. Return true if this actor is enabled to call fire(); return false otherwise.

Specified by:

prefire in interface Executable

Overrides:

prefire in class AtomicActor<TypedIOPort>

Returns:

True if this actor is enabled to call fire(); return false otherwise.

Throws:

IllegalActionException - if there is an exception with the thread activity of this method.

wrapup

public void wrapup()
            throws IllegalActionException

Generate an ExecEvent with a state value of 3. Invoke the wrapup() method of this actor's superclass.

Specified by:

wrapup in interface Initializable

Overrides:

wrapup in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If there is an exception in the execution of the wrapup method of this actor's superclass.