Package ptolemy.domains.ddf.lib

Class DDFSingleTokenCommutator

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.Transformer

ptolemy.actor.lib.SingleTokenCommutator

ptolemy.domains.ddf.lib.DDFSingleTokenCommutator

All Implemented Interfaces:

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

public class DDFSingleTokenCommutator
extends SingleTokenCommutator

The DDFSingleTokenCommutator has a multiport input port and an output port. The types of the ports are undeclared and will be resolved by the type resolution mechanism, with the constraint that the output type must be greater than or equal to the input type. On each call to the fire() method, the actor reads one token from the current input channel, and writes the token to the output port. Then in the postfire() method, it will update token consumption rate of the input port so that it will read token from the next channel in the next iteration.

Since:

Ptolemy II 4.1

Version:

$Id$

Author:

Gang Zhou

Pt.AcceptedRating:

Yellow (cxh)

Pt.ProposedRating:

Yellow (zgang)

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field	Description
Parameter	input_tokenConsumptionRate	This parameter provides token consumption rate for each input channel.

Fields inherited from class ptolemy.actor.lib.Transformer

input, output

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
DDFSingleTokenCommutator(CompositeEntity container, java.lang.String name)	Construct an actor in the specified container with the specified name.

Method Summary

Modifier and Type	Method	Description
void	connectionsChanged(Port port)	Pre-calculate the rates to be set in the rate parameter of the input port.
void	initialize()	Begin execution by setting rate parameter indicating it will read the zeroth input channel.
boolean	postfire()	Update rate parameter indicating the next input channel.

Methods inherited from class ptolemy.actor.lib.SingleTokenCommutator

_getCurrentInputPosition, fire

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, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, 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

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

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, preinitialize, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Nameable

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

Field Detail

input_tokenConsumptionRate

public Parameter input_tokenConsumptionRate

This parameter provides token consumption rate for each input channel. The type is array of ints.

Constructor Detail

DDFSingleTokenCommutator

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

Construct an actor in the specified container with the specified name.

Parameters:

container - The container.

name - This is the name of this distributor within the container.

Throws:

NameDuplicationException - If an actor with an identical name already exists in the container.

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

Method Detail

connectionsChanged

public void connectionsChanged(Port port)

Pre-calculate the rates to be set in the rate parameter of the input port. Initialize the private variable _rateArray, each element of which indicates the input port needs to consume one token from a corresponding channel and no token from the rest of the channels.

Overrides:

connectionsChanged in class AtomicActor<TypedIOPort>

Parameters:

port - The port that has connection changes.

initialize

public void initialize()
                throws IllegalActionException

Begin execution by setting rate parameter indicating it will read the zeroth input channel.

Specified by:

initialize in interface Initializable

Overrides:

initialize in class SingleTokenCommutator

Throws:

IllegalActionException - If there is no director.

postfire

public boolean postfire()
                 throws IllegalActionException

Update rate parameter indicating the next input channel.

Specified by:

postfire in interface Executable

Overrides:

postfire in class SingleTokenCommutator

Returns:

True if execution can continue into the next iteration.

Throws:

IllegalActionException - If any called method throws IllegalActionException.