Package org.opentrafficsim.core.egtf

Class EgtfEvent

java.lang.Object
java.util.EventObject
org.opentrafficsim.core.egtf.EgtfEvent
All Implemented Interfaces:
java.io.Serializable
public class EgtfEvent
extends java.util.EventObject
EGTF event with progress and the ability to interrupt calculations.

Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:
$Revision$, $LastChangedDate$, by $Author$, initial version 8 okt. 2018
Author:
Wouter Schakel
See Also:
Serialized Form

  • Field Summary

    Fields inherited from class java.util.EventObject

    source

  • Method Summary

    Modifier and Type Method Description
    double getProgress()
    Returns the progress, a value in the range [0 ...
    void interrupt()
    Interrupts the filter.
    java.lang.String toString()

    Methods inherited from class java.util.EventObject

    getSource

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Method Details

    • getProgress

      public final double getProgress()
      Returns the progress, a value in the range [0 ... 1].
      Returns:
      double; progress, a value in the range [0 ... 1]

    • interrupt

      public final void interrupt()
      Interrupts the filter. If a filter() calculation is ongoing, it will stop and return null.

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.util.EventObject