Package org.opentrafficsim.draw.graphs

Record Class GraphPath.Section<L>

java.lang.Object
java.lang.Record
org.opentrafficsim.draw.graphs.GraphPath.Section<L>
Type Parameters:
L - underlying type
Record Components:
length - length of the section
speedLimit - speed limit on the section
sections - list of underlying objects
All Implemented Interfaces:
Iterable<L>
Enclosing class:
GraphPath<S>
public static record GraphPath.Section<L>(Length length, Speed speedLimit, List<L> sections) extends Record implements Iterable<L>
Class for sections.

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:
Alexander Verbraeck, Peter Knoppers, Wouter Schakel

  • Constructor Details

    • Section

      public Section(Length length, Speed speedLimit, List<L> sections)
      Creates an instance of a Section record class.
      Parameters:
      length - the value for the length record component
      speedLimit - the value for the speedLimit record component
      sections - the value for the sections record component

  • Method Details

    • getSource

      public L getSource(int series)
      Returns the source object.
      Parameters:
      series - number
      Returns:
      underlying object of the series

    • iterator

      public Iterator<L> iterator()
      Specified by:
      iterator in interface Iterable<L>

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • length

      public Length length()
      Returns the value of the length record component.
      Returns:
      the value of the length record component

    • speedLimit

      public Speed speedLimit()
      Returns the value of the speedLimit record component.
      Returns:
      the value of the speedLimit record component

    • sections

      public List<L> sections()
      Returns the value of the sections record component.
      Returns:
      the value of the sections record component