Package org.opentrafficsim.draw.graphs

Interface ContourDataSource.ContourDataType<Z extends Number,​I>

  • Type Parameters:
    Z - value type
    I - intermediate data type
    Enclosing class:
    ContourDataSource<G extends org.opentrafficsim.kpi.interfaces.GtuDataInterface>
    public static interface ContourDataSource.ContourDataType<Z extends Number,​I>
    Interface for data types of which a contour plot can be made. Using this class, the data pool can determine and store cell values for a variable set of additional data types (besides total distance, total time and speed).

    Copyright (c) 2013-2022 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 10 okt. 2018
    Author:
    Alexander Verbraeck, Peter Knoppers, Wouter Schakel

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Z finalize​(I intermediate)
      Returns the final value of the intermediate result after all lanes.
      org.opentrafficsim.core.egtf.Quantity<Z,​?> getQuantity()
      Returns the quantity that is being plotted on the z-axis for the EGTF filter.
      I identity()
      Returns the initial value for intermediate result.
      I processSeries​(I intermediate, List<org.opentrafficsim.kpi.sampling.TrajectoryGroup<?>> trajectories, List<Length> xFrom, List<Length> xTo, Time tFrom, Time tTo)
      Calculate value from provided trajectories that apply to a single grid cell on a single series (lane).

    • Method Detail

      • identity

        I identity()
        Returns the initial value for intermediate result.
        Returns:
        I, initial intermediate value

      • processSeries

        I processSeries​(I intermediate,
                List<org.opentrafficsim.kpi.sampling.TrajectoryGroup<?>> trajectories,
                List<Length> xFrom,
                List<Length> xTo,
                Time tFrom,
                Time tTo)
        Calculate value from provided trajectories that apply to a single grid cell on a single series (lane).
        Parameters:
        intermediate - I; intermediate value of previous series, starts as the identity
        trajectories - List<TrajectoryGroup<?>>; trajectories, all groups overlap the requested space-time
        xFrom - List<Length>; start location of cell on the section
        xTo - List<Length>; end location of cell on the section.
        tFrom - Time; start time of cell
        tTo - Time; end time of cell
        Returns:
        I; intermediate value

      • finalize

        Z finalize​(I intermediate)
        Returns the final value of the intermediate result after all lanes.
        Parameters:
        intermediate - I; intermediate result after all lanes
        Returns:
        Z; final value

      • getQuantity

        org.opentrafficsim.core.egtf.Quantity<Z,​?> getQuantity()
        Returns the quantity that is being plotted on the z-axis for the EGTF filter.
        Returns:
        Quantity<Z, ?>; quantity that is being plotted on the z-axis for the EGTF filter