Class PteraDirector.TimedEvent

  • All Implemented Interfaces:
    java.lang.Comparable<TimedEvent>
    Enclosing class:
    PteraDirector

    public static class PteraDirector.TimedEvent
    extends TimedEvent
    The class to encapsulate information to be stored in an entry in the event queue.
    Since:
    Ptolemy II 8.0
    Version:
    $Id$
    Author:
    Thomas Huining Feng
    Pt.AcceptedRating:
    Red (tfeng)
    Pt.ProposedRating:
    Yellow (tfeng)
    • Field Summary

      Fields 
      Modifier and Type Field Description
      Token arguments
      Arguments to the event.
      boolean canceled
      Whether this event has been canceled.
      Event.RefiringData data
      The refiring data returned from the previous fire() or refire(), or null if the scheduled firing is the first one.
      boolean reset
      Whether the refinement of the scheduled event should be (re)initialized when the event is processed.
    • Constructor Summary

      Constructors 
      Constructor Description
      TimedEvent​(java.lang.Object object, Time time, Token arguments, Event.RefiringData data, boolean reset)
      Construct a TimedEvent.
    • Field Detail

      • arguments

        public Token arguments
        Arguments to the event.
      • canceled

        public boolean canceled
        Whether this event has been canceled.
      • data

        public Event.RefiringData data
        The refiring data returned from the previous fire() or refire(), or null if the scheduled firing is the first one.
      • reset

        public boolean reset
        Whether the refinement of the scheduled event should be (re)initialized when the event is processed.
    • Constructor Detail

      • TimedEvent

        public TimedEvent​(java.lang.Object object,
                          Time time,
                          Token arguments,
                          Event.RefiringData data,
                          boolean reset)
        Construct a TimedEvent.
        Parameters:
        object - The actor or event.
        time - The model time at which the actor or event is scheduled.
        arguments - Arguments to the event, which must be either an ArrayToken or a RecordToken.
        data - The refiring data for the next refire() invocation of the event that causes this method to be called, or null if none.
        reset - Whether the refinement of the scheduled event should be reinitialized when the event is processed.
    • Method Detail

      • toString

        public java.lang.String toString()
        Display timeStamp and contents.
        Overrides:
        toString in class TimedEvent
        Returns:
        A string that describes this timed event.