ptolemy.domains.dde.lib
Class DDESink

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

public class DDESink
extends TypedAtomicActor

DDESink is simple DDE actor that consumes real tokens. This actor has a parameter named 'numTokens' that specifies the number of real tokens that this actor will consume. If numTokens is set to a negative value, then this actor will continue to consume tokens as long as they are available. If numTokens is set to a non-negative value 'k', then this actor will consume k tokens.

Since:
Ptolemy II 0.3
Version:
$Id: DDESink.java,v 1.25 2004/04/13 03:28:44 cxh Exp $
Author:
John S. Davis II
See Also:
Serialized Form
Accepted Rating:
Red (cxh)
Proposed Rating:
Red (davisj)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.Entity
Entity.ContainedObjectsIterator
 
Field Summary
 TypedIOPort input
          The input port.
 Parameter numTokens
          Indicate the integer valued number of real tokens that this actor should consume.
 
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
DDESink(CompositeEntity container, java.lang.String name)
          Construct a DDESink with the specified container and name.
 
Method Summary
 void fire()
          Execute this actor by consuming a real token.
 boolean postfire()
          Return true if this actor is enabled to proceed with additional iterations.
 
Methods inherited from class ptolemy.actor.TypedAtomicActor
_addPort, attributeTypeChanged, clone, newPort, typeConstraintList
 
Methods inherited from class ptolemy.actor.AtomicActor
_createReceivers, clone, connectionsChanged, getDirector, getExecutiveDirector, getFunctionDependency, getManager, initialize, inputPortList, iterate, 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, 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
initialize, iterate, prefire, 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

input

public TypedIOPort input
The input port.


numTokens

public Parameter numTokens
Indicate the integer valued number of real tokens that this actor should consume. If this value is negative, then there is no limit on the number of tokens that this actor will consume. The default value of this parameter is -1.

Constructor Detail

DDESink

public DDESink(CompositeEntity container,
               java.lang.String name)
        throws IllegalActionException,
               NameDuplicationException
Construct a DDESink with the specified container and name.

Parameters:
container - The container of this actor.
name - The name of this actor.
Method Detail

fire

public void fire()
          throws IllegalActionException
Execute this actor by consuming a real token. If the numTokens parameter has been set to a non-negative value 'k', then stop iterating after 'k' real tokens have been consumed. If the value of numTokens is negative, then continue consuming real tokens as long as they are available.

Specified by:
fire in interface Executable
Overrides:
fire in class AtomicActor
Throws:
IllegalActionException - If there is an exception while accessing the receivers of this actor.

postfire

public boolean postfire()
                 throws IllegalActionException
Return true if this actor is enabled to proceed with additional iterations. Return false otherwise.

Specified by:
postfire in interface Executable
Overrides:
postfire in class AtomicActor
Returns:
True if continued execution is enabled; false otherwise.
Throws:
IllegalActionException - Not thrown in this base class.
See Also:
fire()