ptolemy.domains.fsm.modal
Class ModalController

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.domains.fsm.kernel.FSMActor
                          extended byptolemy.domains.fsm.modal.ModalController
All Implemented Interfaces:
Actor, Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, Executable, ExplicitChangeContext, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable, TypedActor

public class ModalController
extends FSMActor

This FSM actor supports mirroring of its ports in its container (which is required to be a ModalModel), which in turn assures mirroring of ports in each of the refinements.

Note that this actor has no attributes of its own. Requests for attributes are delegated to the container.

Since:
Ptolemy II 2.0
Version:
$Id: ModalController.java,v 1.5 2004/04/13 03:31:07 cxh Exp $
Author:
Edward A. Lee
See Also:
Serialized Form
Accepted Rating:
Red (reviewmoderator)
Proposed Rating:
Red (eal)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.CompositeEntity
CompositeEntity.ContainedObjectsIterator
 
Field Summary
protected  boolean _mirrorDisable
          Indicator that we are processing a newPort request.
 
Fields inherited from class ptolemy.domains.fsm.kernel.FSMActor
_currentState, _inputTokenMap, _lastChosenTransition, _stopRequested, finalStateNames, initialStateName
 
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
ModalController(CompositeEntity container, java.lang.String name)
          Construct a modal controller with a name and a container.
ModalController(Workspace workspace)
          Construct a modal controller in the specified workspace with no container and an empty string as a name.
 
Method Summary
protected  void _checkContainer(Entity container)
          Override the base class to ensure that the proposed container is a ModalModel or null.
 Port newPort(java.lang.String name)
          Create a new port with the specified name in the container of this controller, which in turn creates a port in this controller and all the refinements.
 void setMirrorDisable(boolean disable)
          Control whether adding a port should be mirrored in the modal model and refinements.
 
Methods inherited from class ptolemy.domains.fsm.kernel.FSMActor
_addEntity, _addRelation, _checkTransition, _chooseTransition, _commitLastChosenTransition, _isRefinementOutput, _readInputs, _readInputs, _readOutputsFromRefinement, _setCurrentConnectionMap, attributeChanged, clone, currentState, fire, getContext, getDirector, getExecutiveDirector, getFunctionDependency, getInitialState, getManager, getModifiedVariables, getPortScope, initialize, inputPortList, isOpaque, iterate, newReceiver, newRelation, outputPortList, postfire, prefire, preinitialize, reset, setHDFFSMActor, setNewIteration, stop, stopFire, terminate, typeConstraintList, wrapup
 
Methods inherited from class ptolemy.kernel.CompositeEntity
_adjustDeferrals, _description, _exportMoMLContents, _finishedAddEntity, _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
_addPort, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, propagateExistence, setContainer, setName
 
Methods inherited from class ptolemy.kernel.Entity
_removePort, connectedPortList, connectedPorts, connectionsChanged, 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, 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.Nameable
description, getContainer, getFullName, getName, getName, setName
 
Methods inherited from interface ptolemy.kernel.util.Derivable
getDerivedLevel, getDerivedList, propagateValue
 

Field Detail

_mirrorDisable

protected boolean _mirrorDisable
Indicator that we are processing a newPort request.

Constructor Detail

ModalController

public ModalController(Workspace workspace)
Construct a modal controller 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.

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

ModalController

public ModalController(CompositeEntity container,
                       java.lang.String name)
                throws IllegalActionException,
                       NameDuplicationException
Construct a modal controller with a name and a container. The container argument must not be null, or a NullPointerException will be thrown.

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

newPort

public Port newPort(java.lang.String name)
             throws NameDuplicationException
Create a new port with the specified name in the container of this controller, which in turn creates a port in this controller and all the refinements. This method is write-synchronized on the workspace.

Overrides:
newPort in class FSMActor
Parameters:
name - The name to assign to the newly created port.
Returns:
The new port.
Throws:
NameDuplicationException - If the entity already has a port with the specified name.

setMirrorDisable

public void setMirrorDisable(boolean disable)
Control whether adding a port should be mirrored in the modal model and refinements. This is added to allow control by the UI.

Parameters:
disable - True if mirroring should not occur.

_checkContainer

protected void _checkContainer(Entity container)
                        throws IllegalActionException
Override the base class to ensure that the proposed container is a ModalModel or null.

Parameters:
container - The proposed container.
Throws:
IllegalActionException - If the proposed container is not a TypedActor, or if the base class throws it.