Package org.opentrafficsim.road.network.speed

Record Class SpeedInfoCurvature

java.lang.Object
java.lang.Record
org.opentrafficsim.road.network.speed.SpeedInfoCurvature
Record Components:
radius - Length; curvature radius
All Implemented Interfaces:
Serializable
public record SpeedInfoCurvature(org.djunits.value.vdouble.scalar.Length radius) extends Record implements Serializable
Class with curvature info for curvature speed limit type.

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, Wouter Schakel
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    SpeedInfoCurvature(org.djunits.value.vdouble.scalar.Length radius)
    Constructor with curvature radius.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final org.djunits.value.vdouble.scalar.Speed
    getSpeedForLateralAcceleration(org.djunits.value.vdouble.scalar.Acceleration acceleration)
    Returns the speed for which the current lateral acceleration follows in the corner.
    final int
    hashCode()
    Returns a hash code value for this object.
    org.djunits.value.vdouble.scalar.Length
    radius()
    Returns the value of the radius record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SpeedInfoCurvature

      public SpeedInfoCurvature(org.djunits.value.vdouble.scalar.Length radius)
      Constructor with curvature radius.
      Parameters:
      radius - Length; curvature radius
      Throws:
      NullPointerException - if radius is null

  • Method Details

    • getSpeedForLateralAcceleration

      public final org.djunits.value.vdouble.scalar.Speed getSpeedForLateralAcceleration(org.djunits.value.vdouble.scalar.Acceleration acceleration)
      Returns the speed for which the current lateral acceleration follows in the corner.
      Parameters:
      acceleration - Acceleration; acceleration to result from speed in corner
      Returns:
      speed for which the current lateral acceleration follows in the corner
      Throws:
      NullPointerException - if acceleration is null

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

    • radius

      public org.djunits.value.vdouble.scalar.Length radius()
      Returns the value of the radius record component.
      Returns:
      the value of the radius record component