ptolemy.actor.lib
Class Distributor

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.InstantiableNamedObj
          ptolemy.kernel.Entity
              ptolemy.kernel.ComponentEntity
                  ptolemy.actor.AtomicActor
                      ptolemy.actor.TypedAtomicActor
                          ptolemy.actor.lib.Transformer
                              ptolemy.actor.lib.Distributor

All Implemented Interfaces:

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

public class Distributor
extends Transformer
implements SequenceActor

A polymorphic distributor, which splits an input stream into a set of output streams. The distributor has an input port and an output port, the latter of which is a multiport. 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 at most N tokens from the input, where N is the width of the output port times the blockSize parameter, and writes blockSize tokens to each output channel, in the order of the channels. If there are fewer than N tokens at the input, then the all available input tokens are sent to the output channels, and the fire() method returns. In the next iteration of this actor, it will begin producing outputs on the first channel that did not have enough tokens in the previous iteration.

For the benefit of domains like SDF, which need to know the token consumption or production rate for all ports before they can construct a firing schedule, this actor sets the tokenConsumptionRate parameter for the input port to equal the number of output channels times the blockSize parameter, and the output production rate is set to the blockSize parameter. The consumption rate parameter is set each time that a link is established with the input port, or when a link is removed. The director is notified that the schedule is invalid, so that if the link is modified at run time, the schedule will be recalculated if necessary.

Since:

Ptolemy II 0.2

Version:

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

Author:

Mudit Goel, Edward A. Lee

See Also:

Serialized Form

Accepted Rating:

Yellow (cxh)

Proposed Rating:

Yellow (mudit)

Nested Class Summary

private static class

Distributor.WidthDependentParameter This class will set _port.getWidth() + " * blockSize" as expression of the parameter, but will only do it when the token is requested to delay the triggering of the width.

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

Entity.ContainedObjectsIterator

Field Summary

private int	_currentOutputPosition
private int	_tentativeOutputPosition
Parameter	blockSize The number of tokens produced on each output channel on each firing.
Parameter	input_tokenConsumptionRate The parameter controlling the input port consumption rate.
Parameter	output_tokenProductionRate The parameter specifying the output port production rate.

Fields inherited from class ptolemy.actor.lib.Transformer

input, output

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

Distributor(CompositeEntity container, java.lang.String name)
Construct an actor in the specified container with the specified name.

Method Summary

java.lang.Object	clone(Workspace workspace) Clone the actor into the specified workspace.
void	connectionsChanged(Port port) Notify this entity that the links to the specified port have been altered.
void	fire() Read at most N tokens from the input port, where N is the width of the output port times the blockSize parameter.
void	initialize() Begin execution by setting the current output channel to zero.
boolean	postfire() Update the output position to equal that determined by the most recent invocation of the fire() method.

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, 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

_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

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

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

blockSize

public Parameter blockSize

The number of tokens produced on each output channel on each firing. This is an integer with default value 0.

input_tokenConsumptionRate

public Parameter input_tokenConsumptionRate

The parameter controlling the input port consumption rate. This is an integer, initially with value 0. Whenever a connection is made to the output, the value of this parameter is changed to equal the width of the output times the blockSize parameter.

output_tokenProductionRate

public Parameter output_tokenProductionRate

The parameter specifying the output port production rate. This is an integer, equal to the value of blockSize.

_currentOutputPosition

private int _currentOutputPosition

_tentativeOutputPosition

private int _tentativeOutputPosition

Constructor Detail

Distributor

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

Construct an actor in the specified container with the specified name. Create ports and make the input port a multiport. Create the actor parameters.

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

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException

Clone the actor into the specified workspace. This calls the base class method and sets the public variables to point to the new ports.

Overrides:

clone in class AtomicActor

Parameters:

workspace - The workspace for the new object.

Returns:

A new actor.

Throws:

java.lang.CloneNotSupportedException - If a derived class contains attributes that cannot be cloned.

See Also:

NamedObj.exportMoML(Writer, int, String), NamedObj.setDeferringChangeRequests(boolean)

connectionsChanged

public void connectionsChanged(Port port)

Notify this entity that the links to the specified port have been altered. This sets the consumption rate of the input port and notifies the director that the schedule is invalid, if there is a director. This also sets the current output position to zero, which means that the next consumed input token will be produced on channel zero of the output.

Overrides:

connectionsChanged in class AtomicActor

Parameters:

port - The port that has connection changes.

fire

public void fire()
          throws IllegalActionException

Read at most N tokens from the input port, where N is the width of the output port times the blockSize parameter. Write blockSize tokens to each of the output channels. If there are not N tokens available, then read all the tokens and send them to the outputs. On the next iteration, the actor will pick up where it left off.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor

Throws:

IllegalActionException - If there is no director.

initialize

public void initialize()
                throws IllegalActionException

Begin execution by setting the current output channel to zero.

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AtomicActor

Throws:

IllegalActionException - If there is no director.

postfire

public boolean postfire()
                 throws IllegalActionException

Update the output position to equal that determined by the most recent invocation of the fire() method. The output position is the channel number of the output port to which the next input will be sent.

Specified by:

postfire in interface Executable

Overrides:

postfire in class AtomicActor

Returns:

True if execution can continue into the next iteration.

Throws:

IllegalActionException - If there is no director.