ptolemy.domains.sdf.lib
Class SDFTransformer

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.InstantiableNamedObj
          ptolemy.kernel.Entity
              ptolemy.kernel.ComponentEntity
                  ptolemy.actor.AtomicActor
                      ptolemy.actor.TypedAtomicActor
                          ptolemy.domains.sdf.lib.SDFTransformer

All Implemented Interfaces:

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

Direct Known Subclasses:

ArrayToSequence, Autocorrelation, Autocorrelation, Chop, Chop, CountTrues, DelayLine, DelayLine, DownSample, FFT, FFT, FIR, IFFT, IFFT, LineCoder, MatrixJoin, MatrixSplit, MatrixToSequence, Repeat, SampleDelay, SDFConverter, SequenceToArray, SequenceToMatrix, Simulator, UpSample

public class SDFTransformer
extends TypedAtomicActor
implements SequenceActor

This is an abstract base class for actors that transform an input stream into an output stream. It provides an input and an output port.

Since:

Ptolemy II 1.0

Version:

$Id: SDFTransformer.java 57040 2010-01-27 20:52:32Z cxh $

Author:

Edward A. Lee, Steve Neuendorffer

See Also:

Serialized Form

Accepted Rating:

Yellow (neuendor)

Proposed Rating:

Yellow (eal)

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

TypedIOPort	input The input port.
Parameter	input_tokenConsumptionRate The rate parameter for the input port.
TypedIOPort	output The output port.
Parameter	output_tokenInitProduction The rate parameter for the output port that declares the initial production.
Parameter	output_tokenProductionRate The rate parameter for the output port.

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _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

SDFTransformer(CompositeEntity container, java.lang.String name)
Construct an actor with the given container and name.

Method Summary

boolean

prefire() Return true if the number of available tokens on the input port is at least the declared consumption rate for the port.

Methods inherited from class ptolemy.actor.TypedAtomicActor

_addPort, _fireAt, _fireAt, attributeTypeChanged, clone, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, addActorFiringListener, addInitializable, clone, connectionsChanged, createReceivers, declareDelayDependency, fire, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, 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

_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, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, 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, propagateValue, propagateValues, removeChangeListener, removeDebugListener, 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.actor.Executable

fire, isFireFunctional, isStrict, iterate, postfire, 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

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

input

public TypedIOPort input

The input port. This base class imposes no type constraints except that the type of the input cannot be greater than the type of the output.

input_tokenConsumptionRate

public Parameter input_tokenConsumptionRate

The rate parameter for the input port.

output

public TypedIOPort output

The output port. By default, the type of this output is constrained to be at least that of the input.

output_tokenProductionRate

public Parameter output_tokenProductionRate

The rate parameter for the output port.

output_tokenInitProduction

public Parameter output_tokenInitProduction

The rate parameter for the output port that declares the initial production.

Constructor Detail

SDFTransformer

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

Construct an actor with the given container and name.

Parameters:

container - The container.

name - The name of this actor.

Throws:

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

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

Method Detail

prefire

public boolean prefire()
                throws IllegalActionException

Return true if the number of available tokens on the input port is at least the declared consumption rate for the port. Otherwise return false.

Specified by:

prefire in interface Executable

Overrides:

prefire in class AtomicActor

Returns:

True if there are enough tokens.

Throws:

IllegalActionException - If it is thrown accessing the port.