Package org.opentrafficsim.animation.graphs

Record Class FundamentalDiagram.FdSeries

java.lang.Object
java.lang.Record
org.opentrafficsim.animation.graphs.FundamentalDiagram.FdSeries
Record Components:
q - flow
v - speed
k - density
Enclosing class:
FundamentalDiagram
public static record FundamentalDiagram.FdSeries(float[] q, float[] v, float[] k) extends Record
One data series within a fundamental diagram paint state.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FdSeries(float[] q, float[] v, float[] k)
    Creates an instance of a FdSeries record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    double
    getValue(FundamentalDiagram.Quantity quantity, int item)
    Returns one value for a quantity.
    final int
    hashCode()
    Returns a hash code value for this object.
    float[]
    k()
    Returns the value of the k record component.
    float[]
    q()
    Returns the value of the q record component.
    final String
    toString()
    Returns a string representation of this record class.
    float[]
    v()
    Returns the value of the v record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • FdSeries

      public FdSeries(float[] q, float[] v, float[] k)
      Creates an instance of a FdSeries record class.
      Parameters:
      q - the value for the q record component
      v - the value for the v record component
      k - the value for the k record component

  • Method Details

    • getValue

      public double getValue(FundamentalDiagram.Quantity quantity, int item)
      Returns one value for a quantity.
      Parameters:
      quantity - quantity
      item - item in series
      Returns:
      one value for a quantity

    • 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.

    • q

      public float[] q()
      Returns the value of the q record component.
      Returns:
      the value of the q record component

    • v

      public float[] v()
      Returns the value of the v record component.
      Returns:
      the value of the v record component

    • k

      public float[] k()
      Returns the value of the k record component.
      Returns:
      the value of the k record component