Package org.opentrafficsim.kpi.sampling

Record Class SpaceTimeRegion<L extends LaneData<L>>

java.lang.Object
java.lang.Record
org.opentrafficsim.kpi.sampling.SpaceTimeRegion<L>
Type Parameters:
L - lane data type
Record Components:
lane - L; lane
startPosition - Length; start position
endPosition - Length; end position
startTime - Time; start time
endTime - Time; end time
public record SpaceTimeRegion<L extends LaneData<L>>(L extends LaneData<L> lane, org.djunits.value.vdouble.scalar.Length startPosition, org.djunits.value.vdouble.scalar.Length endPosition, org.djunits.value.vdouble.scalar.Time startTime, org.djunits.value.vdouble.scalar.Time endTime) extends Record
Defines a rectangular region over space and time on a lane.

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 Summary

    Constructors
    Constructor
    Description
    SpaceTimeRegion(L lane, org.djunits.value.vdouble.scalar.Length startPosition, org.djunits.value.vdouble.scalar.Length endPosition, org.djunits.value.vdouble.scalar.Time startTime, org.djunits.value.vdouble.scalar.Time endTime)
    Creates a space-time region.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.djunits.value.vdouble.scalar.Length
    endPosition()
    Returns the value of the endPosition record component.
    org.djunits.value.vdouble.scalar.Time
    endTime()
    Returns the value of the endTime 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.
    L
    lane()
    Returns the value of the lane record component.
    org.djunits.value.vdouble.scalar.Length
    startPosition()
    Returns the value of the startPosition record component.
    org.djunits.value.vdouble.scalar.Time
    startTime()
    Returns the value of the startTime 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

    • SpaceTimeRegion

      public SpaceTimeRegion(L lane, org.djunits.value.vdouble.scalar.Length startPosition, org.djunits.value.vdouble.scalar.Length endPosition, org.djunits.value.vdouble.scalar.Time startTime, org.djunits.value.vdouble.scalar.Time endTime)
      Creates a space-time region.
      Parameters:
      lane - L; lane
      startPosition - Length; start position
      endPosition - Length; end position
      startTime - Time; start time
      endTime - Time; end time
      Throws:
      IllegalArgumentException - if start time is larger than end time

  • Method Details

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

    • lane

      public L lane()
      Returns the value of the lane record component.
      Returns:
      the value of the lane record component

    • startPosition

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

    • endPosition

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

    • startTime

      public org.djunits.value.vdouble.scalar.Time startTime()
      Returns the value of the startTime record component.
      Returns:
      the value of the startTime record component

    • endTime

      public org.djunits.value.vdouble.scalar.Time endTime()
      Returns the value of the endTime record component.
      Returns:
      the value of the endTime record component