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

Class UpstreamNeighborsIterable

java.lang.Object
org.opentrafficsim.road.gtu.lane.perception.AbstractPerceptionReiterable<H,U>
org.opentrafficsim.road.gtu.lane.perception.AbstractPerceptionIterable<HeadwayGtu,LaneBasedGtu,Integer>
org.opentrafficsim.road.gtu.lane.perception.UpstreamNeighborsIterable
All Implemented Interfaces:
Iterable<HeadwayGtu>, PerceptionCollectable<HeadwayGtu,LaneBasedGtu>, PerceptionIterable<HeadwayGtu>
public class UpstreamNeighborsIterable extends AbstractPerceptionIterable<HeadwayGtu,LaneBasedGtu,Integer>
Iterable to find upstream GTU's.

Copyright (c) 2013-2023 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 Details

    • UpstreamNeighborsIterable

      public UpstreamNeighborsIterable(LaneBasedGtu perceivingGtu, LaneRecordInterface<?> root, Length initialPosition, Length maxDistance, RelativePosition relativePosition, HeadwayGtuType headwayGtuType, RelativeLane lane)
      Constructor.
      Parameters:
      perceivingGtu - LaneBasedGtu; perceiving GTU
      root - LaneRecord<?>; root record
      initialPosition - Length; position on the root record
      maxDistance - Length; maximum distance to search
      relativePosition - RelativePosition; position to which distance are calculated by subclasses
      headwayGtuType - HeadwayGtuType; type of HeadwayGtu to return
      lane - RelativeLane; relative lane (used for a left/right distinction to prevent dead-locks)

  • Method Details

    • getNext

      protected AbstractPerceptionIterable<HeadwayGtu,LaneBasedGtu,Integer>.Entry getNext(LaneRecordInterface<?> record, Length position, Integer counter) throws GtuException
      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<HeadwayGtu,LaneBasedGtu,Integer>
      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
      Throws:
      GtuException - on any exception in the process

    • getDistance

      protected Length getDistance(LaneBasedGtu object, LaneRecordInterface<?> 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<HeadwayGtu,LaneBasedGtu,Integer>
      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

    • perceive

      public HeadwayGtu perceive(LaneBasedGtu perceivingGtu, LaneBasedGtu object, Length distance) throws GtuException, org.opentrafficsim.base.parameters.ParameterException
      Returns a perceived version of the underlying object.
      Specified by:
      perceive in class AbstractPerceptionReiterable<HeadwayGtu,LaneBasedGtu>
      Parameters:
      perceivingGtu - LaneBasedGtu; perceiving GTU
      object - U; underlying object
      distance - Length; distance to the object
      Returns:
      H; perceived version of the underlying object
      Throws:
      GtuException - on exception
      org.opentrafficsim.base.parameters.ParameterException - on invalid parameter value or missing parameter