Package ptolemy.domains.ptera.lib

Class Report

    • Field Detail

      • columnsDisplayed

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

      • 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.

    • 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)