ptolemy.actor.lib.hoc
Class LifeCycleManager

java.lang.Object
  extended byptolemy.kernel.util.NamedObj
      extended byptolemy.kernel.InstantiableNamedObj
          extended byptolemy.kernel.Entity
              extended byptolemy.kernel.ComponentEntity
                  extended byptolemy.kernel.CompositeEntity
                      extended byptolemy.actor.CompositeActor
                          extended byptolemy.actor.TypedCompositeActor
                              extended byptolemy.actor.lib.hoc.LifeCycleManager
All Implemented Interfaces:
Actor, Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, Executable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable, TypedActor
Direct Known Subclasses:
RunCompositeActor, TransmitPropertyTransformer

public class LifeCycleManager
extends TypedCompositeActor

This is a composite actor with some services for life-cycle management. FIXME: More.

Since:
Ptolemy II 4.0
Version:
$Id: LifeCycleManager.java,v 1.1 2004/04/20 05:45:38 eal Exp $
Author:
Edward A. Lee, Yang Zhao
See Also:
ModelReference, SetVariable, Serialized Form
Accepted Rating:
Red (eal)
Proposed Rating:
Yellow (eal)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.CompositeEntity
CompositeEntity.ContainedObjectsIterator
 
Field Summary
 
Fields inherited from class ptolemy.actor.CompositeActor
_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
LifeCycleManager()
          Construct an actor in the default workspace with no container and an empty string as its name.
LifeCycleManager(CompositeEntity container, java.lang.String name)
          Construct a LifeCycleManager with a name and a container.
LifeCycleManager(Workspace workspace)
          Construct a LifeCycleManager in the specified workspace with no container and an empty string as a name.
 
Method Summary
protected  int _executeInsideModel()
          Run a complete execution of the contained model.
protected  void _readInputs()
          Iterate over input ports and read any available values into the referenced model parameters.
protected  void _writeOutputs()
          Iterate over output ports and read any available values from the referenced model parameters and produce them on the outputs.
 void executeChangeRequests()
          Execute requested changes.
 boolean isOpaque()
          Return true, since this actor is always opaque.
 void requestChange(ChangeRequest change)
          Request that given change be executed.
 
Methods inherited from class ptolemy.actor.TypedCompositeActor
_addEntity, _addPort, _addRelation, _checkTypesFromTo, _typeConstraintsFromTo, newPort, newRelation, resolveTypes, typeConstraintList
 
Methods inherited from class ptolemy.actor.CompositeActor
_finishedAddEntity, _setDirector, clone, connectionsChanged, fire, getDirector, getExecutiveDirector, getFunctionDependency, getManager, initialize, inputPortList, iterate, newInsideReceiver, newReceiver, outputPortList, postfire, prefire, preinitialize, setContainer, setDirector, setManager, stop, stopFire, terminate, wrapup
 
Methods inherited from class ptolemy.kernel.CompositeEntity
_adjustDeferrals, _description, _exportMoMLContents, _removeEntity, _removeRelation, allAtomicEntityList, allowLevelCrossingConnect, classDefinitionList, connect, connect, containedObjectsIterator, deepEntityList, deepGetEntities, entityList, entityList, exportLinks, getAttribute, getEntities, getEntity, getPort, getRelation, getRelations, isAtomic, numberOfClassDefinitions, numberOfEntities, numberOfRelations, numEntities, numRelations, relationList, removeAllEntities, removeAllRelations, uniqueName, validateSettables
 
Methods inherited from class ptolemy.kernel.ComponentEntity
_checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, propagateExistence, setName
 
Methods inherited from class ptolemy.kernel.Entity
_removePort, connectedPortList, connectedPorts, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition
 
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, exportMoML, exportMoML, exportMoML, exportMoML, getAttribute, getAttributes, getChangeListeners, getClassName, getDerivedLevel, getDerivedList, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, 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.actor.Actor
getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, newReceiver, outputPortList
 
Methods inherited from interface ptolemy.actor.Executable
fire, initialize, iterate, postfire, prefire, preinitialize, stop, stopFire, terminate, wrapup
 
Methods inherited from interface ptolemy.kernel.util.Derivable
getDerivedLevel, getDerivedList, propagateValue
 
Methods inherited from interface ptolemy.kernel.util.Nameable
description, getFullName, getName, getName
 

Constructor Detail

LifeCycleManager

public LifeCycleManager()
Construct an actor in the default workspace with no container and an empty string as its name. Add the actor to the workspace directory. You should set the local director or executive director before attempting to send data to the actor or to execute it. Increment the version number of the workspace.


LifeCycleManager

public LifeCycleManager(Workspace workspace)
Construct a LifeCycleManager in the specified workspace with no container and an empty string as a name. You can then change the name with setName(). If the workspace argument is null, then use the default workspace. You should set the local director or executive director before attempting to send data to the actor or to execute it. Add the actor to the workspace directory. Increment the version number of the workspace.

Parameters:
workspace - The workspace that will list the actor.

LifeCycleManager

public LifeCycleManager(CompositeEntity container,
                        java.lang.String name)
                 throws IllegalActionException,
                        NameDuplicationException
Construct a LifeCycleManager with a name and a container. The container argument must not be null, or a NullPointerException will be thrown. This actor will use the workspace of the container for synchronization and version counts. If the name argument is null, then the name is set to the empty string. Increment the version of the workspace. This actor will have no local director initially, and its executive director will be simply the director of the container.

Parameters:
container - The container.
name - The name of this actor.
Throws:
IllegalActionException - If the container is incompatible with this actor.
NameDuplicationException - If the name coincides with an actor already in the container.
Method Detail

executeChangeRequests

public void executeChangeRequests()
Execute requested changes. In this class, do not delegate the change request to the container, but execute the request immediately. Listeners will be notified of success or failure.

Specified by:
executeChangeRequests in interface Changeable
Overrides:
executeChangeRequests in class NamedObj
See Also:
NamedObj.addChangeListener(ChangeListener), requestChange(ChangeRequest), NamedObj.setDeferringChangeRequests(boolean)

isOpaque

public boolean isOpaque()
Return true, since this actor is always opaque. This method is not synchronized on the workspace, so the caller should be.

Overrides:
isOpaque in class CompositeActor

requestChange

public void requestChange(ChangeRequest change)
Request that given change be executed. In this class, do not delegate the change request to the container, but execute the request immediately or record it, depending on whether setDeferringChangeRequests() has been called. If setDeferChangeRequests() has been called with a true argument, then simply queue the request until either setDeferChangeRequests() is called with a false argument or executeChangeRequests() is called. If this object is already in the middle of executing a change request, then that execution is finished before this one is performed. Change listeners will be notified of success (or failure) of the request when it is executed.

Specified by:
requestChange in interface Changeable
Overrides:
requestChange in class CompositeActor
Parameters:
change - The requested change.
See Also:
executeChangeRequests(), NamedObj.setDeferringChangeRequests(boolean)

_executeInsideModel

protected int _executeInsideModel()
                           throws IllegalActionException
Run a complete execution of the contained model. A complete execution consists of invocation of super.initialize(), repeated invocations of super.prefire(), super.fire(), and super.postfire(), followed by super.wrapup(). The invocations of prefire(), fire(), and postfire() are repeated until either the model indicates it is not ready to execute (prefire() returns false), or it requests a stop (postfire() returns false or stop() is called).

Returns:
One of COMPLETED, STOP_ITERATING, or NOT_READY to indicate that either the execution completed or stop was externally requested, stopped because postfire() returned false, or stopped because prefire() returned false, respectively.
Throws:
IllegalActionException - If there is no director, or if the director's action methods throw it.

_readInputs

protected void _readInputs()
                    throws IllegalActionException
Iterate over input ports and read any available values into the referenced model parameters.

Throws:
IllegalActionException - If reading the ports or setting the parameters causes it.

_writeOutputs

protected void _writeOutputs()
                      throws IllegalActionException
Iterate over output ports and read any available values from the referenced model parameters and produce them on the outputs.

Throws:
IllegalActionException - If reading the parameters or writing to the ports causes it.