ptolemy.domains.csp.lib
Class CSPSource
java.lang.Object
ptolemy.kernel.util.NamedObj
ptolemy.kernel.InstantiableNamedObj
ptolemy.kernel.Entity
ptolemy.kernel.ComponentEntity
ptolemy.actor.AtomicActor
ptolemy.actor.TypedAtomicActor
ptolemy.actor.lib.Source
ptolemy.domains.csp.lib.CSPSource
- 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 CSPSource
- extends Source
A CSPSource actor produces tokens through an output channel.
The tokenLimit parameter specifies how many tokens are
produced by this actor. If the value of tokenLimit is a
nonnegative integer, then the actor produces that many tokens.
If the value is negative, then the actor produces tokens
indefinitely. The default value of tokenLimit is -1.
- Since:
- Ptolemy II 0.2
- Version:
- $Id: CSPSource.java 57040 2010-01-27 20:52:32Z cxh $
- Author:
- Neil Smyth
- 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 |
CSPSource(CompositeActor container,
java.lang.String name,
int limit,
int initValue)
Construct a CSPSource with the specified container and the
specified name. |
Method Summary |
void |
fire()
Execute this actor by producing IntTokens on the output port. |
boolean |
postfire()
Return false indicating that iteration of this actor should
not continue. |
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, 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 |
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.
_value
private int _value
CSPSource
public CSPSource(CompositeActor container,
java.lang.String name,
int limit,
int initValue)
throws IllegalActionException,
NameDuplicationException
- Construct a CSPSource 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. The limit
argument specifies how many tokens will be produced during an
invocation of the fire() method. If the value of limit is set
to -1, then tokens will be produced indefinitely. The initValue
argument specifies the initial integer value of the output
tokens.
- Parameters:
container
- The container of this actor.name
- The name of this actor.limit
- The number of tokens that this actor will produce.initValue
- The initial integer value of the produced
tokens.
- Throws:
IllegalActionException
- If the superclass throws it
or if there is an error with instantiation of the tokenLimit
parameter.
NameDuplicationException
- If the name of this actor
or the tokenLimit parameter is not unique within the container.
fire
public void fire()
throws IllegalActionException
- Execute this actor by producing IntTokens on the output port.
If the tokenCount was not set to a nonnegative, integer value,
then produce output tokens indefinitely. Otherwise, produce
N output tokens for N = tokenCount.
- Specified by:
fire
in interface Executable
- Overrides:
fire
in class Source
- Throws:
IllegalActionException
- If thrown by the superclass.
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 AtomicActor
- Returns:
- false Indicating that iteration of this actor should
should not continue.