ptolemy.vergil.actor.lib
Class ModelDisplay

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.InstantiableNamedObj
          ptolemy.kernel.Entity
              ptolemy.kernel.ComponentEntity
                  ptolemy.actor.AtomicActor
                      ptolemy.actor.TypedAtomicActor
                          ptolemy.actor.gui.AbstractPlaceableActor
                              ptolemy.vergil.actor.lib.ModelDisplay

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Actor, Executable, FiringsRecordable, Placeable, Initializable, TypedActor, Changeable, ChangeListener, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class ModelDisplay
extends AbstractPlaceableActor
implements ChangeListener

This actor opens a window to display the specified model. If inputs are provided, they are expected to be MoML strings that are to be applied to the model. This can be used, for example, to create animations.

Since:

Ptolemy II 8.0

Version:

$Id: ModelDisplay.java 57044 2010-01-27 22:41:05Z cxh $

Author:

Edward A. Lee, Elaine Cheong

See Also:

Serialized Form

Accepted Rating:

Red (cxh)

Proposed Rating:

Yellow (eal)

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

private PtolemyEffigy	_effigy The effigy representing the model.
private NamedObj	_entity The top-level entity read from the file or URL.
private JGraph	_graph The graph display pane.
private Tableau	_tableau The tableau, if the model is displayed in its own window.
TypedIOPort	input The input port through which to provide MoML to modify the model.
FileParameter	modelURL The file or URL from which to read the starting point model.

Fields inherited from class ptolemy.actor.gui.AbstractPlaceableActor

_frame, _paneSize, _windowProperties

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _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

ModelDisplay(CompositeEntity container, java.lang.String name)
Construct an actor with the specified container and name.

Method Summary

private static NamedObj	_createBlankEntity() Create a blank entity associated with this display.
void	attributeChanged(Attribute attribute) React to a change in an attribute.
void	changeExecuted(ChangeRequest change) Do nothing.
void	changeFailed(ChangeRequest change, java.lang.Exception exception) Stop executing the model.
java.lang.Object	clone(Workspace workspace) Clone the actor into the specified workspace.
void	fire() Read the input, if there is any, and issue a change request to apply the MoML in the input to the displayed model.
void	initialize() If the model is not yet displayed, then display it in its own window.
void	place(java.awt.Container container) Place the display in the specified container.

Methods inherited from class ptolemy.actor.gui.AbstractPlaceableActor

_exportMoMLContents, setFrame

Methods inherited from class ptolemy.actor.TypedAtomicActor

_addPort, _fireAt, _fireAt, attributeTypeChanged, clone, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, 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

_description, _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, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, 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

Methods inherited from interface ptolemy.actor.Actor

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

Methods inherited from interface ptolemy.actor.Executable

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

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, preinitialize, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Nameable

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

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

modelURL

public FileParameter modelURL

The file or URL from which to read the starting point model. The model is read when this parameter is set or changed.

input

public TypedIOPort input

The input port through which to provide MoML to modify the model. This has type string.

_effigy

private PtolemyEffigy _effigy

The effigy representing the model.

_entity

private NamedObj _entity

The top-level entity read from the file or URL.

_graph

private JGraph _graph

The graph display pane.

_tableau

private Tableau _tableau

The tableau, if the model is displayed in its own window.

Constructor Detail

ModelDisplay

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

Construct an actor with the specified container and name.

Parameters:

container - The container.

name - The name of this actor.

Throws:

IllegalActionException - If the entity cannot be contained by the proposed container.

NameDuplicationException - If the container already has an actor with this name.

Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

React to a change in an attribute. If the attribute is modelURL, then read the specified URL and parse it to create the entity to display.

Overrides:

attributeChanged in class NamedObj

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If the change is not acceptable to this container (not thrown in this base class).

changeExecuted

public void changeExecuted(ChangeRequest change)

Do nothing.

Specified by:

changeExecuted in interface ChangeListener

Parameters:

change - The change that succeeded.

changeFailed

public void changeFailed(ChangeRequest change,
                         java.lang.Exception exception)

Stop executing the model.

Specified by:

changeFailed in interface ChangeListener

Parameters:

change - The change.

exception - The exception.

fire

public void fire()
          throws IllegalActionException

Read the input, if there is any, and issue a change request to apply the MoML in the input to the displayed model.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor

Throws:

IllegalActionException - If there is an error reading the input.

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException

Clone the actor into the specified workspace.

Overrides:

clone in class AtomicActor

Parameters:

workspace - The workspace for the new object.

Returns:

A new actor.

Throws:

java.lang.CloneNotSupportedException - If a derived class has an attribute that cannot be cloned.

See Also:

NamedObj.exportMoML(Writer, int, String), NamedObj.setDeferringChangeRequests(boolean)

initialize

public void initialize()
                throws IllegalActionException

If the model is not yet displayed, then display it in its own window.

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AtomicActor

Throws:

IllegalActionException - If there is an constructing the display.

place

public void place(java.awt.Container container)

Place the display in the specified container.

Specified by:

place in interface Placeable

Specified by:

place in class AbstractPlaceableActor

Parameters:

container - The container, or null to remove it from any existing container.

_createBlankEntity

private static NamedObj _createBlankEntity()

Create a blank entity associated with this display.