ptolemy.domains.csp.lib
Class CSPMultiSink

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.domains.csp.kernel.CSPActor
                              extended byptolemy.domains.csp.lib.CSPMultiSink
All Implemented Interfaces:
Actor, Changeable, java.lang.Cloneable, ConditionalBranchActor, Debuggable, DebugListener, Derivable, Executable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable, TypedActor

public class CSPMultiSink
extends CSPActor

A CSPMultiSink actor accepts a token from any channel connected to its input. It uses a conditional do (CDO) construct to always be ready to accept a new token. The channels it can accept from are set at the start of each firing.

Since:
Ptolemy II 0.2
Version:
$Id: CSPMultiSink.java,v 1.38 2004/04/13 03:25:14 cxh Exp $
Author:
Neil Smyth
See Also:
CSPActor, Serialized Form
Accepted Rating:
Red (nsmyth)
Proposed Rating:
Red (nsmyth)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.Entity
Entity.ContainedObjectsIterator
 
Field Summary
 TypedIOPort input
          This actor's input port.
 
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
CSPMultiSink()
          Construct a CSPMultiSink in the default workspace with an empty string as its name.
CSPMultiSink(TypedCompositeActor container, java.lang.String name)
          Construct a CSPMultiSink with the specified container and name.
 
Method Summary
 void fire()
          Execute this actor by consuming tokens through the input port.
 boolean postfire()
          Return false indicating that iteration of this actor should not continue.
 void wrapup()
          Discontinue the execution of this actor.
 
Methods inherited from class ptolemy.domains.csp.kernel.CSPActor
_cancelDelay, _continue, _waitForDeadlock, chooseBranch, clone, delay, getConditionalBranchController, initialize, terminate
 
Methods inherited from class ptolemy.actor.TypedAtomicActor
_addPort, attributeTypeChanged, clone, newPort, typeConstraintList
 
Methods inherited from class ptolemy.actor.AtomicActor
_createReceivers, connectionsChanged, getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, iterate, newReceiver, outputPortList, prefire, preinitialize, pruneDependencies, removeDependency, setContainer, stop, stopFire
 
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, prefire, preinitialize, stop, stopFire
 
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

input

public TypedIOPort input
This actor's input port.

Constructor Detail

CSPMultiSink

public CSPMultiSink()
Construct a CSPMultiSink in the default workspace with an empty string as its name. The actor is created with a single input port named "input".


CSPMultiSink

public CSPMultiSink(TypedCompositeActor container,
                    java.lang.String name)
             throws IllegalActionException,
                    NameDuplicationException
Construct a CSPMultiSink with the specified container and name. The actor is created with a single input port named "input". The name of the actor must be unique within the container or a NameDuplicationException is thrown. The container argument must not be null, or a NullPointerException will be thrown.

Throws:
IllegalActionException - If the port cannot be contained by this actor.
NameDuplicationException - If the port name coincides with a port already in this actor.
Method Detail

fire

public void fire()
Execute this actor by consuming tokens through the input port. Use a conditional do (CDO) construct for token consumption.

Specified by:
fire in interface Executable
Overrides:
fire in class AtomicActor

postfire

public boolean postfire()
Return false indicating that iteration of this actor should not continue.

Specified by:
postfire in interface Executable
Overrides:
postfire in class CSPActor
Returns:
false Indicating that iteration of this actor should should not continue.

wrapup

public void wrapup()
Discontinue the execution of this actor.

Specified by:
wrapup in interface Executable
Overrides:
wrapup in class AtomicActor