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-2019 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 19 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
UpstreamNeighborsIterable(LaneBasedGTU perceivingGtu, LaneRecord<?> root, Length initialPosition, Length maxDistance, RelativePosition relativePosition, HeadwayGtuType headwayGtuType, RelativeLane lane)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected Length	getDistance(LaneBasedGTU object, LaneRecord<?> record, Length position)	Returns the distance to the object.
protected AbstractPerceptionIterable.Entry	getNext(LaneRecord<?> record, Length position, Integer counter)	Returns the next object(s) on the lane represented by the record.
HeadwayGTU	perceive(LaneBasedGTU perceivingGtu, LaneBasedGTU object, Length distance)	Returns a perceived version of the underlying object.

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

getDx, isDownstream, primaryIterator

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

collect, first, getGtu, isEmpty, iterator, underlying, underlyingWithDistance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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 Details

UpstreamNeighborsIterable

public UpstreamNeighborsIterable(LaneBasedGTU perceivingGtu, LaneRecord<?> 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.Entry getNext(LaneRecord<?> 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, 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<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, 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

ParameterException - on invalid parameter value or missing parameter