Package org.opentrafficsim.animation.graphs

Class GraphPath<S>

java.lang.Object
org.opentrafficsim.animation.graphs.AbstractGraphSpace<S>
org.opentrafficsim.animation.graphs.GraphPath<S>
Type Parameters:
S - underlying type of path sections
All Implemented Interfaces:
Iterable<S>
public class GraphPath<S> extends AbstractGraphSpace<S>
A GraphPath defines the spatial dimension of graphs. It has a number of sections, each of which may have one or more source objects depending on the number of series. For example, a 3-lane road may result in a few sections each having 3 series. Graphs can aggregate the series, or show multiple series.

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

Author:
Alexander Verbraeck, Peter Knoppers, Wouter Schakel

  • Constructor Details

    • GraphPath

      public GraphPath(String name, List<GraphPath.Section<S>> sections)
      Constructor for a one-series path.
      Parameters:
      name - name
      sections - sections

    • GraphPath

      public GraphPath(List<String> seriesNames, List<GraphPath.Section<S>> sections)
      Constructor.
      Parameters:
      seriesNames - names of series
      sections - sections

  • Method Details

    • setCircular

      public GraphPath<S> setCircular(boolean circular)
      Sets whether this path is circular.
      Parameters:
      circular - whether this path is circular
      Returns:
      this graph path for method chaining

    • isCircular

      public boolean isCircular()
      Returns whether this path is circular.
      Returns:
      whether this path is circular

    • getStartDistance

      public org.djunits.value.vdouble.scalar.Length getStartDistance(GraphPath.Section<?> section)
      Returns the start distance of the section.
      Parameters:
      section - Section<?> section
      Returns:
      start distance of the section

    • getTotalLength

      public org.djunits.value.vdouble.scalar.Length getTotalLength()
      Returns the total path length.
      Returns:
      total path length

    • getSpeedLimit

      public org.djunits.value.vdouble.scalar.Speed getSpeedLimit()
      Returns the mean speed over the entire section.
      Returns:
      mean speed over the entire section

    • get

      public GraphPath.Section<S> get(int index)
      Returns a section.
      Parameters:
      index - index of section
      Returns:
      section

    • iterator

      public Iterator<S> iterator()

    • iterator

      public Iterator<S> iterator(int series)

    • getSections

      public ImmutableList<GraphPath.Section<S>> getSections()
      Returns an immutable list of the sections.
      Returns:
      sections

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • initRecording

      public static <L extends LaneData<L>> void initRecording(Sampler<?,L> sampler, GraphPath<L> path)
      Start recording along path.
      Type Parameters:
      L - lane data type
      Parameters:
      sampler - sampler
      path - path