ptolemy.actor.lib
Class Commutator

java.lang.Object
  extended byptolemy.kernel.util.NamedObj
      extended byptolemy.kernel.InstantiableNamedObj
          extended byptolemy.kernel.Entity
              extended byptolemy.kernel.ComponentEntity
                  extended byptolemy.actor.AtomicActor
                      extended byptolemy.actor.TypedAtomicActor
                          extended byptolemy.actor.lib.Transformer
                              extended byptolemy.actor.lib.Commutator
All Implemented Interfaces:
ptolemy.actor.Actor, ptolemy.kernel.util.Changeable, java.lang.Cloneable, ptolemy.kernel.util.Debuggable, ptolemy.kernel.util.DebugListener, ptolemy.kernel.util.Derivable, ptolemy.actor.Executable, ptolemy.kernel.util.Instantiable, ptolemy.kernel.util.ModelErrorHandler, ptolemy.kernel.util.MoMLExportable, ptolemy.kernel.util.Nameable, SequenceActor, java.io.Serializable, ptolemy.actor.TypedActor

public class Commutator
extends Transformer
implements SequenceActor

A polymorphic commutator, which merges a set of input sequences into a single output sequence. The commutator has an input port (a multiport) and an output port (a single 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 each input channel and sends the token to the output port. The order in which the tokens are produced is the order of the channels in the input multiport. If any input channel has no token, then the fire method returns. In the next iteration, the actor will begin reading at the channel that had no input token in the previous iteration. If no input token is available on the first channel being read, then no output is produced.

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 tokenProductionRate parameter for the output port to equal the number of input channels. This 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: Commutator.java,v 1.46 2004/04/13 03:02:35 cxh Exp $
Author:
Mudit Goel, Edward A. Lee
See Also:
Serialized Form
Accepted Rating:
Yellow (cxh)
Proposed Rating:
Yellow (mudit)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.Entity
ptolemy.kernel.Entity.ContainedObjectsIterator
 
Field Summary
 ptolemy.data.expr.Parameter output_tokenProductionRate
          The parameter controlling the output port production rate.
 
Fields inherited from class ptolemy.actor.lib.Transformer
input, output
 
Fields inherited from class ptolemy.actor.AtomicActor
_stopRequested
 
Fields inherited from class ptolemy.kernel.util.NamedObj
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS
 
Fields inherited from interface ptolemy.actor.Executable
COMPLETED, NOT_READY, STOP_ITERATING
 
Constructor Summary
Commutator(ptolemy.kernel.CompositeEntity container, java.lang.String name)
          Construct an actor in the specified container with the specified name.
 
Method Summary
 java.lang.Object clone(ptolemy.kernel.util.Workspace workspace)
          Clone the actor into the specified workspace.
 void connectionsChanged(ptolemy.kernel.Port port)
          Notify this entity that the links to the specified port have been altered.
 void fire()
          Read one token from each input channel and send it to the output port.
 void initialize()
          Begin execution by setting the current input channel to zero.
 boolean postfire()
          Update the input position to equal that determined by the most recent invocation of the fire() method.
 boolean prefire()
          Return false if the current input position does not have an input token.
 
Methods inherited from class ptolemy.actor.TypedAtomicActor
_addPort, attributeTypeChanged, clone, newPort, typeConstraintList
 
Methods inherited from class ptolemy.actor.AtomicActor
_createReceivers, getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, iterate, newReceiver, outputPortList, preinitialize, pruneDependencies, removeDependency, setContainer, stop, stopFire, terminate, wrapup
 
Methods inherited from class ptolemy.kernel.ComponentEntity
_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, propagateExistence, setName
 
Methods inherited from class ptolemy.kernel.Entity
_description, _exportMoMLContents, _removePort, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName, validateSettables
 
Methods inherited from class ptolemy.kernel.InstantiableNamedObj
_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition
 
Methods inherited from class ptolemy.kernel.util.NamedObj
_addAttribute, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, getAttribute, getAttributes, getChangeListeners, getClassName, getDerivedLevel, getDerivedList, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setModelErrorHandler, setPersistent, setSource, toplevel, toString, workspace
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface ptolemy.actor.Actor
getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, newReceiver, outputPortList
 
Methods inherited from interface ptolemy.actor.Executable
iterate, preinitialize, stop, stopFire, terminate, wrapup
 
Methods inherited from interface ptolemy.kernel.util.Derivable
getDerivedLevel, getDerivedList, propagateValue
 
Methods inherited from interface ptolemy.kernel.util.Nameable
description, getFullName, getName, getName
 

Field Detail

output_tokenProductionRate

public ptolemy.data.expr.Parameter output_tokenProductionRate
The parameter controlling the output port production rate. This parameter contains an IntToken, initially with a value of 0.

Constructor Detail

Commutator

public Commutator(ptolemy.kernel.CompositeEntity container,
                  java.lang.String name)
           throws ptolemy.kernel.util.NameDuplicationException,
                  ptolemy.kernel.util.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 commutator within the container.
Throws:
ptolemy.kernel.util.NameDuplicationException - If an actor with an identical name already exists in the container.
ptolemy.kernel.util.IllegalActionException - If the actor cannot be contained by the proposed container.
Method Detail

clone

public java.lang.Object clone(ptolemy.kernel.util.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.

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.

connectionsChanged

public void connectionsChanged(ptolemy.kernel.Port port)
Notify this entity that the links to the specified port have been altered. This sets the production rate of the output port and notifies the director that the schedule is invalid, if there is a director.


fire

public void fire()
          throws ptolemy.kernel.util.IllegalActionException
Read one token from each input channel and send it to the output port. If an input channel has no token, suspend firing and return. In this case, the actor makes a record of the input channel that it last attempted to read so that it can start reading at that channel in the next iteration. The order in which the tokens are produced is the order of the channels in the input port.

Specified by:
fire in interface ptolemy.actor.Executable
Throws:
ptolemy.kernel.util.IllegalActionException - If there is no director.

initialize

public void initialize()
                throws ptolemy.kernel.util.IllegalActionException
Begin execution by setting the current input channel to zero.

Specified by:
initialize in interface ptolemy.actor.Executable
Throws:
ptolemy.kernel.util.IllegalActionException - If there is no director.

postfire

public boolean postfire()
                 throws ptolemy.kernel.util.IllegalActionException
Update the input position to equal that determined by the most recent invocation of the fire() method. The input position is the channel number of the input port from which the next input will be read.

Specified by:
postfire in interface ptolemy.actor.Executable
Throws:
ptolemy.kernel.util.IllegalActionException - If there is no director.

prefire

public boolean prefire()
                throws ptolemy.kernel.util.IllegalActionException
Return false if the current input position does not have an input token.

Specified by:
prefire in interface ptolemy.actor.Executable
Returns:
False if the current input position has no token.
Throws:
ptolemy.kernel.util.IllegalActionException - If input.hasToken() throws it.