Package org.opentrafficsim.road.gtu.lane.perception

Class LaneBasedObjectIterable<H extends Headway,​L extends LaneBasedObject>

java.lang.Object
org.opentrafficsim.road.gtu.lane.perception.AbstractPerceptionReiterable<H,​U>
org.opentrafficsim.road.gtu.lane.perception.AbstractPerceptionIterable<H,​L,​java.lang.Boolean>
org.opentrafficsim.road.gtu.lane.perception.LaneBasedObjectIterable<H,​L>
Type Parameters:
H - headway type
L - lane based object type
All Implemented Interfaces:
java.lang.Iterable<H>, PerceptionCollectable<H,​L>, PerceptionIterable<H>
public abstract class LaneBasedObjectIterable<H extends Headway,​L extends LaneBasedObject>
extends AbstractPerceptionIterable<H,​L,​java.lang.Boolean>
Iterable that searches downstream or upstream for a certain type of lane based object.

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

Version:
$Revision$, $LastChangedDate$, by $Author$, initial version 16 feb. 2018
Author:
Alexander Verbraeck, Peter Knoppers, Wouter Schakel

  • Constructor Details

    • LaneBasedObjectIterable

      public LaneBasedObjectIterable​(LaneBasedGTU perceivingGtu, java.lang.Class<L> clazz, LaneRecord<?> root, Length initialPosition, boolean downstream, Length maxDistance, RelativePosition relativePosition, Route route)
      Constructor.
      Parameters:
      perceivingGtu - LaneBasedGTU; perceiving GTU
      clazz - Class<L>; class of lane based objects to return
      root - LaneRecord<?>; root record
      initialPosition - Length; initial position
      downstream - boolean; downstream
      maxDistance - Length; max distance to search
      relativePosition - RelativePosition; relative position
      route - Route; route of the GTU, may be null

  • Method Details

    • getNext

      protected AbstractPerceptionIterable.Entry getNext​(LaneRecord<?> record, Length position, java.lang.Boolean counter)
      Returns the next object(s) on the lane represented by the record. This should only consider objects on the given lane. This method should not check the distance towards objects with the maximum distance. The counter will be null for the first object(s). For following object(s) it is whatever value is given with the previous output Entry. Hence, this method maintains its own counting system.
      Specified by:
      getNext in class AbstractPerceptionIterable<H extends Headway,​L extends LaneBasedObject,​java.lang.Boolean>
      Parameters:
      record - LaneRecord<?>; record representing the lane and direction
      position - Length; position to look beyond
      counter - C; counter
      Returns:
      next object(s) on the lane or null if none

    • getDistance

      protected final Length getDistance​(L object, LaneRecord<?> record, Length position)
      Returns the distance to the object. The position fed in to this method is directly taken from an Entry returned by getNext. The two methods need to be consistent with each other.
      Specified by:
      getDistance in class AbstractPerceptionIterable<H extends Headway,​L extends LaneBasedObject,​java.lang.Boolean>
      Parameters:
      object - U; underlying object
      record - LaneRecord<?>; record representing the lane and direction
      position - Length; position of the object on the lane
      Returns:
      Length; distance to the object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object