ptolemy.actor.lib
Class Stop
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.Sink
ptolemy.actor.lib.Stop
- 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 Stop
- extends Sink
An actor that stops execution of a model when it receives a true
token on any input channel. This is accomplished by calling
finish() on the director, which requests that the current iteration
be completed and then the execution be halted. This actor will
also call stopFire() which requests that any actors that are
firing concurrently in separate threads conclude their firings.
This is necessary to support threaded domains like PN. If the input
is not connected to anything, then this actor requests a stop
whenever it fires.
When exactly this stops the execution depends on the domain. For
example, in DE, if an event with time stamp T and value
true arrives at this actor, then the current iteration will
be concluded, and then the model will halt. Concluding the current
iteration means processing all events in the event queue with time
stamp T. Thus, it is possible for actors to be invoked after
this one is invoked with a true input.
In SDF, if this actor receives true, then the current
iteration is concluded and then execution is stopped. Similarly in
SR.
In PN, where each actor has its own thread, there is no
well-defined notion of an iteration. The finish() method of the
manager calls stopFire() on all actors, which for threaded actors
results in halting them upon their next attempt to read an input or
write an output. When all actor threads have stopped, the iteration
concludes and the model halts. NOTE: This is not the best
way to stop a PN model! This mechanism is nondeterministic in
the sense that there is no way to control exactly what data is
produced or consumed on the connections before the model stops. To
stop a PN model, it is better to design the model so that all
actors are starved of data when the model is to stop. The director
will detect this starvation, and halt the model. Nonetheless, if
the nondeterminism is acceptable, this actor can be used.
- Since:
- Ptolemy II 2.1
- Version:
- $Id: Stop.java 57046 2010-01-27 23:35:53Z cxh $
- Author:
- Edward A. Lee
- See Also:
- Serialized Form
- Accepted Rating:
- Proposed Rating:
| Fields inherited from class ptolemy.actor.lib.Sink |
input |
| 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 |
Stop(CompositeEntity container,
java.lang.String name)
Construct an actor in the specified container with the specified
name. |
|
Method Summary |
boolean |
postfire()
Read one token from each input channel that has a token,
and if any token is true, call finish() on the manager. |
| Methods inherited from class ptolemy.actor.AtomicActor |
_actorFiring, _actorFiring, addActorFiringListener, addInitializable, clone, connectionsChanged, createReceivers, declareDelayDependency, fire, 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 |
_hideName
public SingletonParameter _hideName
- The parameter that hides the name of the actor. The default
value is true.
Stop
public Stop(CompositeEntity container,
java.lang.String name)
throws IllegalActionException,
NameDuplicationException
- Construct an actor in the specified container with the specified
name.
- Parameters:
container - The container.name - The name of this actor within the container.
- Throws:
IllegalActionException - If the actor cannot be contained
by the proposed container.
NameDuplicationException - If the name coincides with
an actor already in the container.
postfire
public boolean postfire()
throws IllegalActionException
- Read one token from each input channel that has a token,
and if any token is true, call finish() on the manager.
If nothing at all is connected to the input port, then
call finish() unconditionally.
- Specified by:
postfire in interface Executable- Overrides:
postfire in class AtomicActor
- Returns:
- False if a stop is requested, and true otherwise.
- Throws:
IllegalActionException - If there is no director or
if there is no manager, or if the container is not a
CompositeActor.