ptolemy.domains.dde.lib
Class DDESink
java.lang.Object
ptolemy.kernel.util.NamedObj
ptolemy.kernel.InstantiableNamedObj
ptolemy.kernel.Entity
ptolemy.kernel.ComponentEntity
ptolemy.actor.AtomicActor
ptolemy.actor.TypedAtomicActor
ptolemy.domains.dde.lib.DDESink
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
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 57040 2010-01-27 20:52:32Z cxh $
- Author:
- John S. Davis II
- See Also:
- Serialized Form
- Accepted Rating:
- Proposed Rating:
Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
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.AtomicActor |
_actorFiring, _actorFiring, addActorFiringListener, addInitializable, clone, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, 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.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 |
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.
_count
private int _count
_continue
private boolean _continue
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.
- Throws:
NameDuplicationException
- If the name of this actor
duplicates that of a actor already contained by the container
of this actor.
IllegalActionException
- If there are errors in
instantiating and specifying the type of this actor's ports.
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()