Package org.opentrafficsim.road.network.speed

Record Class SpeedLimit

java.lang.Object
java.lang.Record
org.opentrafficsim.road.network.speed.SpeedLimit
Record Components:
speed - speed limit
enforced - whether the speed limit is enforced (e.g. speed camera)
public record SpeedLimit(org.djunits.value.vdouble.scalar.Speed speed, boolean enforced) extends Record
Speed limit information.

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

Author:
Wouter Schakel

  • Constructor Summary

    Constructors
    Constructor
    Description
    SpeedLimit(org.djunits.value.vdouble.scalar.Speed speed, boolean enforced)
    Creates an instance of a SpeedLimit record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    enforced()
    Returns the value of the enforced record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    static SpeedLimit
    of(org.djunits.value.vdouble.scalar.Speed speed)
    Returns a standard non-enforced speed limit.
    org.djunits.value.vdouble.scalar.Speed
    speed()
    Returns the value of the speed 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

    • SpeedLimit

      public SpeedLimit(org.djunits.value.vdouble.scalar.Speed speed, boolean enforced)
      Creates an instance of a SpeedLimit record class.
      Parameters:
      speed - the value for the speed record component
      enforced - the value for the enforced record component

  • Method Details

    • of

      public static SpeedLimit of(org.djunits.value.vdouble.scalar.Speed speed)
      Returns a standard non-enforced speed limit.
      Parameters:
      speed - speed limit
      Returns:
      standard non-enforced speed limit

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • speed

      public org.djunits.value.vdouble.scalar.Speed speed()
      Returns the value of the speed record component.
      Returns:
      the value of the speed record component

    • enforced

      public boolean enforced()
      Returns the value of the enforced record component.
      Returns:
      the value of the enforced record component