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,Boolean>

org.opentrafficsim.road.gtu.lane.perception.LaneBasedObjectIterable<H,L>

Type Parameters:

H - headway type

L - lane based object type

All Implemented Interfaces:

Iterable<H>, PerceptionCollectable<H,L>, PerceptionIterable<H>

public abstract class LaneBasedObjectIterable<H extends Headway,L extends LaneBasedObject>
extends AbstractPerceptionIterable<H,L,Boolean>

Iterable that searches downstream or upstream for a certain type of lane based object.

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

Nested Class Summary

Nested classes/interfaces inherited from class org.opentrafficsim.road.gtu.lane.perception.AbstractPerceptionIterable

AbstractPerceptionIterable.Entry

Nested classes/interfaces inherited from class org.opentrafficsim.road.gtu.lane.perception.AbstractPerceptionReiterable

AbstractPerceptionReiterable.PerceptionIterator, AbstractPerceptionReiterable.PrimaryIteratorEntry

Nested classes/interfaces inherited from interface org.opentrafficsim.road.gtu.lane.perception.PerceptionCollectable

PerceptionCollectable.Intermediate<I>, PerceptionCollectable.PerceptionAccumulator<U,I>, PerceptionCollectable.PerceptionCollector<C,U,I>, PerceptionCollectable.PerceptionFinalizer<C,I>, PerceptionCollectable.UnderlyingDistance<U>

Constructor Summary

Constructors

Constructor	Description
LaneBasedObjectIterable(LaneBasedGTU perceivingGtu, Class<L> clazz, LaneRecord<?> root, Length initialPosition, boolean downstream, Length maxDistance, RelativePosition relativePosition, Route route)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected Length	getDistance(L object, LaneRecord<?> record, Length position)	Returns the distance to the object.
protected AbstractPerceptionIterable.Entry	getNext(LaneRecord<?> record, Length position, Boolean counter)	Returns the next object(s) on the lane represented by the record.
String	toString()

Methods inherited from class org.opentrafficsim.road.gtu.lane.perception.AbstractPerceptionIterable

getDx, isDownstream, isOnRoute, primaryIterator

Methods inherited from class org.opentrafficsim.road.gtu.lane.perception.AbstractPerceptionReiterable

addNext, assureNext, collect, first, getGtu, getPrimaryIterator, isEmpty, iterator, perceive, underlying, underlyingWithDistance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.opentrafficsim.road.gtu.lane.perception.PerceptionCollectable

collect

Constructor Detail

LaneBasedObjectIterable

public LaneBasedObjectIterable(LaneBasedGTU perceivingGtu,
                               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 Detail

getNext

protected AbstractPerceptionIterable.Entry getNext(LaneRecord<?> record,
                                                   Length position,
                                                   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,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,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 String toString()

Overrides:

toString in class Object