ptolemy.domains.csp.lib
Class CSPSink

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

public class CSPSink
extends AtomicActor

A CSPSink actor accepts tokens from a single input channel. Ten tokens can be consumed for every invocation of this actor's fire() method. Once ten tokens have been received, the fire method returns. The return value of the postfire() method defaults to false.

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

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.Entity
Entity.ContainedObjectsIterator
 
Field Summary
 IOPort input
          The input port.
 Parameter tokenLimit
          The number of tokens produced by this actor.
 
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
CSPSink()
          Construct a CSPSink in the default workspace with an empty string as a name.
CSPSink(CompositeActor container, java.lang.String name, int limit)
          Construct a CSPSink with the specified container and the specified name.
 
Method Summary
 void fire()
          Execute this actor by consuming ten tokens through the input port.
 boolean postfire()
          Return false indicating that this actor should not be executed in the next iteration of the containing composite actor.
 
Methods inherited from class ptolemy.actor.AtomicActor
_addPort, _createReceivers, clone, connectionsChanged, getDirector, getExecutiveDirector, getFunctionDependency, getManager, initialize, inputPortList, iterate, newPort, newReceiver, outputPortList, prefire, 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, attributeTypeChanged, clone, 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.kernel.util.Derivable
getDerivedLevel, getDerivedList, propagateValue
 
Methods inherited from interface ptolemy.kernel.util.Nameable
description, getFullName, getName, getName
 

Field Detail

input

public IOPort input
The input port.


tokenLimit

public Parameter tokenLimit
The number of tokens produced by this actor. If this limit is set to -1, then produce output tokens indefinitely. The default value of this parameter is -1.

Constructor Detail

CSPSink

public CSPSink()
        throws IllegalActionException,
               NameDuplicationException
Construct a CSPSink in the default workspace with an empty string as a name.

Throws:
IllegalActionException - If there is an error with instantiation of the tokenLimit parameter.
NameDuplicationException - If there is an error with instantiation of the tokenLimit parameter.

CSPSink

public CSPSink(CompositeActor container,
               java.lang.String name,
               int limit)
        throws IllegalActionException,
               NameDuplicationException
Construct a CSPSink with the specified container and the specified name. The name must be unique within the container or an exception is thrown. The container argument must not be null, or a NullPointerException will be thrown.

Parameters:
container - The container of this actor.
name - The name of this actor.
limit - The number of tokens that this actor will produce.
Throws:
IllegalActionException - If the superclass throws it or if there is an error with instantiation of the tokenLimit parameter.
NameDuplicationException - If the name of the actor or the tokenLimit parameter is not unique within the container.
Method Detail

fire

public void fire()
Execute this actor by consuming ten tokens through the input port.

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

postfire

public boolean postfire()
Return false indicating that this actor should not be executed in the next iteration of the containing composite actor.

Specified by:
postfire in interface Executable
Overrides:
postfire in class AtomicActor
Returns:
True indicating that execution of this actor should not be repeated.