ptolemy.actor.gt.controller

Class View

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity

ptolemy.domains.modal.kernel.State

ptolemy.domains.ptera.kernel.Event

ptolemy.actor.gt.controller.GTEvent

ptolemy.actor.gt.controller.View

All Implemented Interfaces:

java.lang.Cloneable, Initializable, ConfigurableEntity, Changeable, Configurable, Debuggable, DebugListener, Derivable, DropTargetHandler, Flowable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class View
extends GTEvent

An event to view the model in the model parameter in a separate window. If the tableau parameter is ignored as the default, a new window is opened for each such event. If the referredTableau parameter is specified with the name of a tableau, then the specified tableau will be used to view the model.

Since:

Ptolemy II 8.0

Version:

$Id$

Author:

Thomas Huining Feng

Pt.AcceptedRating:

Red (tfeng)

Pt.ProposedRating:

Yellow (tfeng)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.domains.ptera.kernel.Event

Event.EventParameter, Event.RefiringData

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

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
Parameter	isPersistent If the isPersistent parameter is false, then the user will not be prompted to save the model upon closing.
StringParameter	referredTableau Name of the tableau referred to, or an empty string if the default tableau is to be used.
Parameter	reopenWindow Whether the window should be closed and reopened on each update.
Parameter	screenLocation Location of the new window, or [-1, -1] if the default location is to be used.
Parameter	screenSize Size of the new window, or [-1, -1] if the default size is to be used.
TableauParameter	tableau The default tableau.
Parameter	title Title of the window.

Fields inherited from class ptolemy.actor.gt.controller.GTEvent

refinementExtender

Fields inherited from class ptolemy.domains.ptera.kernel.Event

actions, isEndingEvent, isFinalEvent, isInitialEvent, parameters

Fields inherited from class ptolemy.domains.modal.kernel.State

incomingPort, isFinalState, isInitialState, outgoingPort, refinementName, saveRefinementsInConfigurer

Fields inherited from class ptolemy.kernel.util.NamedObj

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

Constructor Summary

Constructors

Constructor and Description
View(CompositeEntity container, java.lang.String name) Construct an event with the given name contained by the specified composite entity.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone(Workspace workspace) Clone the event into the specified workspace.
Event.RefiringData	fire(Token arguments) Process this event and show the model in the model parameter in the designated tableau.
void	initialize() Initialize this event.

Methods inherited from class ptolemy.actor.gt.controller.GTEvent

getModelParameter, setContainer

Methods inherited from class ptolemy.domains.ptera.kernel.Event

_getParserScope, _isActiveRefinement, addInitializable, attributeChanged, getController, isEndingEvent, isFinalEvent, isInitialEvent, preinitialize, refire, removeInitializable, scheduleEvents, stop, wrapup

Methods inherited from class ptolemy.domains.modal.kernel.State

_exportMoMLContents, configure, dropObject, errorTransitionList, getConfigurer, getConfigureSource, getConfigureText, getIncomingPort, getObjectInRefinement, getOutgoingPort, getRefinement, nonErrorNonTerminationTransitionList, nonpreemptiveTransitionList, preemptiveTransitionList, terminationTransitionList

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, newPort, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_addPort, _description, _removePort, _validateSettables, connectedPortList, connectedPorts, connectionsChanged, 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, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, 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.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getDisplayName, getFullName, getName, getName

Field Detail

isPersistent

public Parameter isPersistent

If the isPersistent parameter is false, then the user will not be prompted to save the model upon closing. Models in the test suite might want to have this parameter set to false so as to avoid a dialog asking if the user wants to save the model. The default is a boolean with a value of false, indicating that the user will be not prompted to save the model if the model has changed.

referredTableau

public StringParameter referredTableau

Name of the tableau referred to, or an empty string if the default tableau is to be used.

reopenWindow

public Parameter reopenWindow

Whether the window should be closed and reopened on each update.

screenLocation

public Parameter screenLocation

Location of the new window, or [-1, -1] if the default location is to be used.

screenSize

public Parameter screenSize

Size of the new window, or [-1, -1] if the default size is to be used.

tableau

public TableauParameter tableau

The default tableau.

title

public Parameter title

Title of the window.

Constructor Detail

View

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

Construct an event with the given name contained by the specified composite entity. The container argument must not be null, or a NullPointerException will be thrown. This event 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 constructor write-synchronizes on the workspace.

Parameters:

container - The container.

name - The name of the state.

Throws:

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

NameDuplicationException - If the name coincides with that of an entity already in the container.

Method Detail

clone

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

Clone the event into the specified workspace. This calls the base class and then sets the attribute and port public members to refer to the attributes and ports of the new state.

Overrides:

clone in class Event

Parameters:

workspace - The workspace for the new event.

Returns:

A new event.

Throws:

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

See Also:

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

fire

public Event.RefiringData fire(Token arguments)
                        throws IllegalActionException

Process this event and show the model in the model parameter in the designated tableau.

Overrides:

fire in class Event

Parameters:

arguments - The arguments used to process this event, which must be either an ArrayToken or a RecordToken.

Returns:

A refiring data structure that contains a non-negative double number if refire() should be called after that amount of model time, or null if refire() need not be called.

Throws:

IllegalActionException - If the tableau cannot be used, or if thrown by the superclass.

See Also:

Event.refire(Token, RefiringData)

initialize

public void initialize()
                throws IllegalActionException

Initialize this event.

Specified by:

initialize in interface Initializable

Overrides:

initialize in class Event

Throws:

IllegalActionException - If thrown by the superclass.