Package ptolemy.domains.coroutine.kernel

Class AtomicContinuationActor

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity<T>

ptolemy.actor.AtomicActor<TypedIOPort>

ptolemy.actor.TypedAtomicActor

ptolemy.domains.coroutine.kernel.AtomicContinuationActor

All Implemented Interfaces:

java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Continuation, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

Direct Known Subclasses:

Conditional, Counter, Emit, Pause

public abstract class AtomicContinuationActor
extends TypedAtomicActor
implements Continuation

Since:

Ptolemy II 11.0

Version:

$Id$

Author:

shaver

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.HashMap<ControlEntryToken.EntryLocation,TypedIOPort>	_entryPoints
protected java.util.HashMap<TypedIOPort,ControlEntryToken.EntryLocation>	_entryPointsR
protected TypedIOPort	_entryPort
protected java.util.HashMap<ControlExitToken.ExitLocation,TypedIOPort>	_exitPoints
protected java.util.HashMap<TypedIOPort,ControlExitToken.ExitLocation>	_exitPointsR
protected TypedIOPort	_exitPort
protected TypedIOPort	_initPoint
protected TypedIOPort	_resumePoint

Fields inherited from class ptolemy.actor.TypedAtomicActor

_typesValid

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

Constructors

Constructor	Description
AtomicContinuationActor()
AtomicContinuationActor(CompositeEntity container, java.lang.String name)
AtomicContinuationActor(Workspace workspace)

Method Summary

Modifier and Type	Method	Description
void	addEntryLocation(ControlEntryToken.EntryLocation l)
void	addExitLocation(ControlExitToken.ExitLocation l)
ControlExitToken	controlEnter(ControlEntryToken entry)
ControlExitToken	controlEnterAt(ControlEntryToken.EntryLocation location)
ControlExitToken	controlInit()
ControlExitToken	controlResume()
java.util.List<ControlEntryToken.EntryLocation>	entryLocations()	Returns the set of exposed Entry Locations.
java.util.List<ControlExitToken.ExitLocation>	exitLocations()	Returns the set of exposed Exit Locations.
void	fire()	Do nothing.
ControlEntryToken	getEntryActionFromPort(TypedIOPort p)
ControlExitToken.ExitLocation	getExitLocationFromPort(TypedIOPort p)

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, 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

_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, decorators, 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, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, 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

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Methods inherited from interface ptolemy.actor.Executable

isFireFunctional, isStrict, iterate, postfire, prefire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, initialize, preinitialize, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Field Detail

_entryPort

protected TypedIOPort _entryPort

_exitPort

protected TypedIOPort _exitPort

_initPoint

protected TypedIOPort _initPoint

_resumePoint

protected TypedIOPort _resumePoint

_entryPoints

protected java.util.HashMap<ControlEntryToken.EntryLocation,TypedIOPort> _entryPoints

_entryPointsR

protected java.util.HashMap<TypedIOPort,ControlEntryToken.EntryLocation> _entryPointsR

_exitPoints

protected java.util.HashMap<ControlExitToken.ExitLocation,TypedIOPort> _exitPoints

_exitPointsR

protected java.util.HashMap<TypedIOPort,ControlExitToken.ExitLocation> _exitPointsR

Constructor Detail

AtomicContinuationActor

public AtomicContinuationActor()

AtomicContinuationActor

public AtomicContinuationActor(Workspace workspace)

AtomicContinuationActor

public AtomicContinuationActor(CompositeEntity container,
                               java.lang.String name)
                        throws IllegalActionException,
                               NameDuplicationException

Throws:

IllegalActionException

NameDuplicationException

Method Detail

controlEnter

public ControlExitToken controlEnter(ControlEntryToken entry)
                              throws IllegalActionException

Specified by:

controlEnter in interface Continuation

Throws:

IllegalActionException

controlInit

public ControlExitToken controlInit()
                             throws IllegalActionException

Specified by:

controlInit in interface Continuation

Throws:

IllegalActionException

controlResume

public ControlExitToken controlResume()
                               throws IllegalActionException

Specified by:

controlResume in interface Continuation

Throws:

IllegalActionException

controlEnterAt

public ControlExitToken controlEnterAt(ControlEntryToken.EntryLocation location)
                                throws IllegalActionException

Specified by:

controlEnterAt in interface Continuation

Throws:

IllegalActionException

entryLocations

public java.util.List<ControlEntryToken.EntryLocation> entryLocations()

Description copied from interface: Continuation

Returns the set of exposed Entry Locations. Some internal entry locations may exist that are not exposed to the interface.

Specified by:

entryLocations in interface Continuation

exitLocations

public java.util.List<ControlExitToken.ExitLocation> exitLocations()

Description copied from interface: Continuation

Returns the set of exposed Exit Locations. Some internal exit locations may exist that are not exposed to the interface.

Specified by:

exitLocations in interface Continuation

addEntryLocation

public void addEntryLocation(ControlEntryToken.EntryLocation l)
                      throws IllegalActionException,
                             NameDuplicationException

Throws:

IllegalActionException

NameDuplicationException

addExitLocation

public void addExitLocation(ControlExitToken.ExitLocation l)
                     throws IllegalActionException,
                            NameDuplicationException

Throws:

IllegalActionException

NameDuplicationException

getEntryActionFromPort

public ControlEntryToken getEntryActionFromPort(TypedIOPort p)

getExitLocationFromPort

public ControlExitToken.ExitLocation getExitLocationFromPort(TypedIOPort p)

fire

public void fire()
          throws IllegalActionException

Description copied from class: AtomicActor

Do nothing. Derived classes override this method to define their primary run-time action.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - Not thrown in this base class.