ptolemy.domains.ptera.lib
Class Report

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.InstantiableNamedObj
          ptolemy.kernel.Entity
              ptolemy.kernel.ComponentEntity
                  ptolemy.domains.modal.kernel.State
                      ptolemy.domains.ptera.kernel.Event
                          ptolemy.domains.ptera.lib.Report

All Implemented Interfaces:

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

public class Report
extends Event

An event to report a message to the user in various forms.

Since:

Ptolemy II 8.0

Version:

$Id: Report.java 57046 2010-01-27 23:35:53Z cxh $

Author:

Thomas Huining Feng

See Also:

Serialized Form

Accepted Rating:

Red (tfeng)

Proposed Rating:

Yellow (tfeng)

Nested Class Summary

static class

Report.Mode The display modes.

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

private static MessageHandler	_MESSAGE_HANDLER The message handler for the dialogs.
Parameter	columnsDisplayed The horizontal size of the display, in columns.
StringParameter	message The message to be displayed.
ChoiceParameter	mode The display mode.
StringParameter	referredTableau The tableau parameter referred to, or an empty string.
Parameter	response The last received yes-or-no response.
Parameter	rowsDisplayed The vertical size of the display, in rows.
TableauParameter	tableau The default tableau.

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, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Constructor Summary

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

Method Summary

Event.RefiringData

fire(Token arguments) Process this event.

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

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

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

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

Methods inherited from class ptolemy.kernel.ComponentEntity

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

Methods inherited from class ptolemy.kernel.Entity

_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, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeList, attributeList, attributeTypeChanged, clone, 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.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getDisplayName, getFullName, getName, getName

Field Detail

columnsDisplayed

public Parameter columnsDisplayed

The horizontal size of the display, in columns. This contains an integer, and defaults to 40.

message

public StringParameter message

The message to be displayed.

mode

public ChoiceParameter mode

The display mode.

referredTableau

public StringParameter referredTableau

The tableau parameter referred to, or an empty string.

response

public Parameter response

The last received yes-or-no response.

rowsDisplayed

public Parameter rowsDisplayed

The vertical size of the display, in rows. This contains an integer, and defaults to 10.

tableau

public TableauParameter tableau

The default tableau.

_MESSAGE_HANDLER

private static final MessageHandler _MESSAGE_HANDLER

The message handler for the dialogs.

Constructor Detail

Report

public Report(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

fire

public Event.RefiringData fire(Token arguments)
                        throws IllegalActionException

Process this event. If the mode is Report.Mode.ERROR, a message is shown in an error dialog. If the mode is Report.Mode.EXCEPTION, a message is shown in the form of an exception. If the mode is Report.Mode.MESSAGE, a message is shown in a message dialog. If the mode is Report.Mode.TABLEAU, a tableau is opened to show the message. The default tableau is the one defined in the tableau parameter. However, if referredTableau is not an empty string, its value is interpreted as the name of the tableau parameter in the model, whose tableau should be used instead of the default one. If the mode is Report.Mode.WARNING, a message is shown in a warning dialog. If the mode is Report.Mode.YES_OR_NO, a query dialog is shown with the message, which allows the user to answer with yes or no. The answer is stored in response.

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)