Package ptolemy.domains.sdf.optimize.lib

Class DummyDisplay

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.actor.lib.Sink

ptolemy.domains.sdf.optimize.lib.DummyDisplay

All Implemented Interfaces:

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

public class DummyDisplay
extends Sink
implements BufferingProfile

Class comments

A DummyDisplay is a simple sink implementing the BufferingProfile interface. It is used for testing the OptimizingSDFDirector.

See OptimizingSDFDirector, OptimizingSDFScheduler and BufferingProfile for more information.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Marc Geilen

See Also:

OptimizingSDFDirector, OptimizingSDFScheduler, BufferingProfile

Pt.AcceptedRating:

Red ()

Pt.ProposedRating:

Red (mgeilen)

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Fields inherited from class ptolemy.actor.lib.Sink

input

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
DummyDisplay(CompositeEntity container, java.lang.String name)	Create an instance of a testing actor to mimic a display sink actor.

Method Summary

Modifier and Type	Method	Description
int	exclusiveBuffers()	Provides the buffering profile, number of buffers required for an exclusive firing.
int	exclusiveExecutionTime()	Provides the buffering profile, execution time estimate required for an exclusive firing.
int	iterate(int iterationCount, boolean fireExclusive)	Iterates the dummy display actor.
int	sharedBuffers()	Provides the buffering profile, number of buffers required for a shared firing.
int	sharedExecutionTime()	Provides the buffering profile, execution time estimate required for a shared firing.

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, fire, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate, wrapup

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

fire, isFireFunctional, isStrict, iterate, postfire, prefire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, initialize, preinitialize, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Nameable

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

Constructor Detail

DummyDisplay

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

Create an instance of a testing actor to mimic a display sink actor.

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

iterate

public int iterate(int iterationCount,
                   boolean fireExclusive)
            throws IllegalActionException

Iterates the dummy display actor.

Specified by:

iterate in interface BufferingProfile

Parameters:

iterationCount - The number of iterations to perform.

fireExclusive - Indicates whether firing is exclusive.

Returns:

NOT_READY, STOP_ITERATING, or COMPLETED.

Throws:

IllegalActionException - If iterating is not permitted, or if prefire(), fire(), or postfire() throw it.

sharedBuffers

public int sharedBuffers()

Provides the buffering profile, number of buffers required for a shared firing.

Specified by:

sharedBuffers in interface BufferingProfile

Returns:

number of buffers for shared firing

exclusiveBuffers

public int exclusiveBuffers()

Provides the buffering profile, number of buffers required for an exclusive firing.

Specified by:

exclusiveBuffers in interface BufferingProfile

Returns:

number of buffers for exclusive firing

sharedExecutionTime

public int sharedExecutionTime()

Provides the buffering profile, execution time estimate required for a shared firing.

Specified by:

sharedExecutionTime in interface BufferingProfile

Returns:

execution time for shared firing

exclusiveExecutionTime

public int exclusiveExecutionTime()

Provides the buffering profile, execution time estimate required for an exclusive firing.

Specified by:

exclusiveExecutionTime in interface BufferingProfile

Returns:

execution time for exclusive firing