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

Class MultiLanePerceptionIterable<P extends LaneBasedObject,H extends Headway,U>

java.lang.Object

org.opentrafficsim.road.gtu.lane.perception.AbstractPerceptionReiterable<P,H,U>

org.opentrafficsim.road.gtu.lane.perception.MultiLanePerceptionIterable<P,H,U>

Type Parameters:

P - perceiving object type

H - headway type

U - underlying headway type

All Implemented Interfaces:

Iterable<H>, PerceptionCollectable<H,U>, PerceptionIterable<H>

public class MultiLanePerceptionIterable<P extends LaneBasedObject,H extends Headway,U>
extends AbstractPerceptionReiterable<P,H,U>

Iterable class to search over multiple lanes.

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

Nested Class Summary

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.UnderlyingDistance<U>

Constructor Summary

Constructors

Constructor	Description
MultiLanePerceptionIterable(P perceivingObject)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addIterable(RelativeLane lane, AbstractPerceptionReiterable<P,H,U> iterable)	Adds an iterable for a lane.
H	perceive(U object, org.djunits.value.vdouble.scalar.Length distance)	Returns a perceived version of the underlying object.
Iterator<AbstractPerceptionReiterable<P,H,U>.PrimaryIteratorEntry>	primaryIterator()	Returns the primary iterator.

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

addNext, assureNext, collect, first, getObject, getPrimaryIterator, 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

MultiLanePerceptionIterable

public MultiLanePerceptionIterable(P perceivingObject)

Constructor.

Parameters:

perceivingObject - perceiving object

Method Details

addIterable

public void addIterable(RelativeLane lane,
 AbstractPerceptionReiterable<P,H,U> iterable)

Adds an iterable for a lane.

Parameters:

lane - lane

iterable - iterable

primaryIterator

public Iterator<AbstractPerceptionReiterable<P,H,U>.PrimaryIteratorEntry> primaryIterator()

Description copied from class: AbstractPerceptionReiterable

Returns the primary iterator. This method is called once by AbstractPerceptionReiterable.

Specified by:

primaryIterator in class AbstractPerceptionReiterable<P extends LaneBasedObject,H extends Headway,U>

Returns:

primary iterator

perceive

public H perceive(U object,
 org.djunits.value.vdouble.scalar.Length distance)
           throws GtuException,
org.opentrafficsim.base.parameters.ParameterException

Description copied from class: AbstractPerceptionReiterable

Returns a perceived version of the underlying object.

Specified by:

perceive in class AbstractPerceptionReiterable<P extends LaneBasedObject,H extends Headway,U>

Parameters:

object - underlying object

distance - distance to the object

Returns:

perceived version of the underlying object

Throws:

GtuException - on exception

org.opentrafficsim.base.parameters.ParameterException - on invalid parameter value or missing parameter