ptolemy.domains.csp.lib
Class CSPSource

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

public class CSPSource
extends AtomicActor

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,v 1.40 2004/04/13 03:25:22 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 output
          The output 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
CSPSource()
          Construct a CSPSource in the default workspace with an empty string as a name.
CSPSource(CompositeActor container, java.lang.String name)
          Construct a CSPSource with the specified container and the specified name.
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
_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

output

public IOPort output
The output 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

CSPSource

public CSPSource()
          throws IllegalActionException,
                 NameDuplicationException
Construct a CSPSource 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.

CSPSource

public CSPSource(CompositeActor container,
                 java.lang.String name)
          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.

Parameters:
container - The container of this actor.
name - The name of this actor.
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.

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.
Method Detail

fire

public void fire()
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 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 AtomicActor
Returns:
false Indicating that iteration of this actor should should not continue.