ptolemy.domains.ct.kernel
Class CTCompositeActor

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.domains.ct.kernel.CTCompositeActor
All Implemented Interfaces:
Actor, Changeable, java.lang.Cloneable, CTEventGenerator, CTStepSizeControlActor, Debuggable, DebugListener, Derivable, Executable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable, TypedActor
Direct Known Subclasses:
ModalModel, Refinement

public class CTCompositeActor
extends TypedCompositeActor
implements CTEventGenerator, CTStepSizeControlActor

Composite actor in the CT domain. This class is derived from TypedCompositeActor and implements the CTStepSizeControlActor interface. Normally, in the CT domain, opaque composite actors are not fired in every iteration. They are only fired in discrete iterations, when there is a possibility of events. Actors that implement the CTStepSizeControlActor interface, however, such as this one, are fired in every iteration.

The key task of this actor is to implement step-size control methods. If the director of this composite actor is an instance of CTTransparentDirector, then the CTStepSizeControlActor calls will be delegated to its local director. Otherwise, they return default values.

This composite actor should be used when a CT subsystem needs to transfer its step size control information to the outer domain. Typical usage includes CT inside CT or CT inside FSM inside CT. If you construct a modal model, then by default, refinements of the modes are actors like this one that implement the CTStepSizeControlActor interface.

Since:
Ptolemy II 0.2
Version:
$Id: CTCompositeActor.java,v 1.39 2004/04/13 03:26:18 cxh Exp $
Author:
Jie Liu
See Also:
CTStepSizeControlActor, CTTransparentDirector, Serialized Form
Accepted Rating:
Yellow (chf)
Proposed Rating:
Yellow (liuj)

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
CTCompositeActor()
          Construct a CTCompositeActor in the default workspace with no container and an empty string as its name.
CTCompositeActor(CompositeEntity container, java.lang.String name)
          Create an CTCompositeActor with a name and a container.
CTCompositeActor(Workspace workspace)
          Construct a CTCompositeActor in the specified workspace with no container and an empty string as a name.
 
Method Summary
 boolean hasCurrentEvent()
          This method is delegated to the local director if the local director is an instance of CTTransparentDirector.
 boolean isThisStepAccurate()
          This method is delegated to the local director if the local director is an instance of CTTransparentDirector.
 double predictedStepSize()
          This method is delegated to the local director if the local director is an instance of CTTransparentDirector.
 double refinedStepSize()
          This method is delegated to the local director if the local director is an instance of CTTransparentDirector.
 
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, isOpaque, iterate, newInsideReceiver, newReceiver, outputPortList, postfire, prefire, preinitialize, requestChange, 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, 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, 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

CTCompositeActor

public CTCompositeActor()
Construct a CTCompositeActor in the default workspace with no container and an empty string as its name. Add the actor to the workspace directory. The director should be set before attempting to execute it. The container should be set before sending data to it. Increment the version number of the workspace.


CTCompositeActor

public CTCompositeActor(Workspace workspace)
Construct a CTCompositeActor 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. The director should be set before attempting to execute it. The container should be set before sending data to it. Increment the version number of the workspace.

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

CTCompositeActor

public CTCompositeActor(CompositeEntity container,
                        java.lang.String name)
                 throws IllegalActionException,
                        NameDuplicationException
Create an CTCompositeActor 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. The director should be set before attempting to execute it.

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

hasCurrentEvent

public boolean hasCurrentEvent()
This method is delegated to the local director if the local director is an instance of CTTransparentDirector. Otherwise, return false, indicating that this composite actor does not have an event at the current time.

Specified by:
hasCurrentEvent in interface CTEventGenerator
Returns:
True if there is an event at the current time.

isThisStepAccurate

public boolean isThisStepAccurate()
This method is delegated to the local director if the local director is an instance of CTTransparentDirector. Otherwise, return true, indicating that this composite actor does not perform step size control.

Specified by:
isThisStepAccurate in interface CTStepSizeControlActor
Returns:
True if this step is accurate.

predictedStepSize

public double predictedStepSize()
This method is delegated to the local director if the local director is an instance of CTTransparentDirector. Otherwise, return java.lang.Double.MAX_VALUE.

Specified by:
predictedStepSize in interface CTStepSizeControlActor
Returns:
The predicted step size.

refinedStepSize

public double refinedStepSize()
This method is delegated to the local director if the local director is an instance of CTTransparentDirector. Otherwise, return the current step size of the executive director.

Specified by:
refinedStepSize in interface CTStepSizeControlActor
Returns:
The refined step size.