Package org.opentrafficsim.draw.egtf

Class EgtfEvent

java.lang.Object

java.util.EventObject

org.opentrafficsim.draw.egtf.EgtfEvent

All Implemented Interfaces:

Serializable

public class EgtfEvent
extends EventObject

EGTF event with progress and the ability to interrupt calculations.

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

Author:

Wouter Schakel

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
EgtfEvent(Egtf egtf, double progress)	Constructor.

Method Summary

Modifier and Type	Method	Description
final double	getProgress()	Returns the progress, a value in the range [0 ... 1].
final void	interrupt()	Interrupts the filter.
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

Constructor Details

EgtfEvent

EgtfEvent(Egtf egtf,
 double progress)

Constructor.

Parameters:

egtf - EGTF; egtf

progress - double; progress, a value in the range [0 ... 1]

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 String toString()

Overrides:

toString in class EventObject