org.opentrafficsim.road.gtu.lane.perception.categories.neighbors

Interface NeighborsPerception

All Superinterfaces:

LaneBasedPerceptionCategory, PerceptionCategory<LaneBasedGTU,LanePerception>

All Known Implementing Classes:

AbstractDelayedNeighborsPerception, DelayedNeighborsPerception, DirectNeighborsPerception, HistoricalNeighborsPerception

public interface NeighborsPerception
extends LaneBasedPerceptionCategory

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 14 feb. 2017

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Method Summary

Modifier and Type	Method and Description
SortedSet<HeadwayGTU>	getFirstFollowers(LateralDirectionality lat) Set of followers on a lane, which is usually 0 or 1, but possibly more in case of an upstream merge with no intermediate GTU.
SortedSet<HeadwayGTU>	getFirstLeaders(LateralDirectionality lat) Set of leaders on a lane, which is usually 0 or 1, but possibly more in case of a downstream split with no intermediate GTU.
PerceptionCollectable<HeadwayGTU,LaneBasedGTU>	getFollowers(RelativeLane lane) Set of followers on a lane, including adjacent GTU's who's FRONT is back of the own vehicle FRONT.
PerceptionCollectable<HeadwayGTU,LaneBasedGTU>	getLeaders(RelativeLane lane) Set of leaders on a lane, including adjacent GTU's who's FRONT is ahead of the own vehicle FRONT.
boolean	isGtuAlongside(LateralDirectionality lat) Whether there is a GTU alongside, i.e.
void	updateFirstFollowers(LateralDirectionality lat) Update set of followers on a lane, which is usually 0 or 1, but possibly more in case of an upstream merge with no intermediate GTU.
void	updateFirstLeaders(LateralDirectionality lat) Update set of leaders on a lane, which is usually 0 or 1, but possibly more in case of a downstream split with no intermediate GTU.
void	updateFollowers(RelativeLane lane) Update set of followers on a lane, including adjacent GTU's who's FRONT is back of the own vehicle FRONT.
void	updateGtuAlongside(LateralDirectionality lat) Update whether there is a GTU alongside, i.e.
void	updateLeaders(RelativeLane lane) Update set of leaders on a lane, including adjacent GTU's who's FRONT is ahead of the own vehicle FRONT.

Methods inherited from interface org.opentrafficsim.core.gtu.perception.PerceptionCategory

updateAll

Method Detail

updateFirstLeaders

void updateFirstLeaders(LateralDirectionality lat)
                 throws ParameterException,
                        GTUException,
                        NetworkException

Update set of leaders on a lane, which is usually 0 or 1, but possibly more in case of a downstream split with no intermediate GTU.

Parameters:

lat - LateralDirectionality; LEFT or RIGHT

Throws:

NetworkException - in case of a network exception

GTUException - if the GTU was not initialized

ParameterException - if a parameter was not present or out of bounds

NullPointerException - if lat is null

IllegalArgumentException - if lat is NONE

updateFirstFollowers

void updateFirstFollowers(LateralDirectionality lat)
                   throws GTUException,
                          ParameterException,
                          NetworkException

Update set of followers on a lane, which is usually 0 or 1, but possibly more in case of an upstream merge with no intermediate GTU.

Parameters:

lat - LateralDirectionality; LEFT or RIGHT

Throws:

NetworkException - in case of a network exception

GTUException - if the GTU was not initialized

ParameterException - if a parameter was not present or out of bounds

NullPointerException - if lat is null

IllegalArgumentException - if lat is NONE

updateGtuAlongside

void updateGtuAlongside(LateralDirectionality lat)
                 throws GTUException,
                        ParameterException,
                        NetworkException

Update whether there is a GTU alongside, i.e. with overlap, in an adjacent lane.

Parameters:

lat - LateralDirectionality; LEFT or RIGHT

Throws:

NetworkException - in case of a network exception

GTUException - if the GTU was not initialized

ParameterException - if parameter is not defined

NullPointerException - if lat is null

IllegalArgumentException - if lat is NONE

updateLeaders

void updateLeaders(RelativeLane lane)
            throws ParameterException,
                   GTUException,
                   NetworkException

Update set of leaders on a lane, including adjacent GTU's who's FRONT is ahead of the own vehicle FRONT. Distance will be from the own vehicle FRONT to their REAR. This is negative for (partially) adjacent vehicles.

Parameters:

lane - RelativeLane; relative lateral lane

Throws:

NetworkException - in case of a network exception

GTUException - if the GRU was not initialized

ParameterException - if a parameter was not present or out of bounds

updateFollowers

void updateFollowers(RelativeLane lane)
              throws GTUException,
                     NetworkException,
                     ParameterException

Update set of followers on a lane, including adjacent GTU's who's FRONT is back of the own vehicle FRONT. Distance will be from their FRONT to the own vehicle REAR. This is negative for (partially) adjacent vehicles.

Parameters:

lane - RelativeLane; relative lateral lane

Throws:

NetworkException - in case of a network exception

GTUException - if the GRU was not initialized

ParameterException - if a parameter was not present or out of bounds

getFirstLeaders

SortedSet<HeadwayGTU> getFirstLeaders(LateralDirectionality lat)
                               throws ParameterException,
                                      NullPointerException,
                                      IllegalArgumentException

Set of leaders on a lane, which is usually 0 or 1, but possibly more in case of a downstream split with no intermediate GTU. This is shown below. Suppose A needs to go straight. If A considers a lane change to the left, both GTUs B (who's tail ~ is still on the straight lane) and C need to be considered for whether it's safe to do so. In case of multiple splits close to one another, the returned set may contain even more than 2 leaders. Leaders are sorted by headway value.

          | |
 _________/B/_____
 _ _?_ _ _~_ _C_ _
 _ _A_ _ _ _ _ _ _
 _________________
 

Only vehicles who's rear is beyond the own front are considered, no alongside vehicles.

Parameters:

lat - LateralDirectionality; LEFT or RIGHT

Returns:

list of followers on a lane

Throws:

ParameterException - if parameter is not defined

NullPointerException - if lat is null

IllegalArgumentException - if lat is NONE

getFirstFollowers

SortedSet<HeadwayGTU> getFirstFollowers(LateralDirectionality lat)
                                 throws ParameterException,
                                        NullPointerException,
                                        IllegalArgumentException

Set of followers on a lane, which is usually 0 or 1, but possibly more in case of an upstream merge with no intermediate GTU. This is shown below. If A considers a lane change to the left, both GTUs B and C need to be considered for whether it's safe to do so. In case of multiple merges close to one another, the returned set may contain even more than 2 followers. Followers are sorted by tailway value.

        | |
        |C| 
 ________\ \______
 _ _B_|_ _ _ _ _?_
 _ _ _|_ _ _ _ _A_ 
 _____|___________
 

Only vehicles who's front is before the own rear are considered, no alongside vehicles.

Parameters:

lat - LateralDirectionality; LEFT or RIGHT

Returns:

list of followers on a lane

Throws:

ParameterException - if parameter is not defined

NullPointerException - if lat is null

IllegalArgumentException - if lat is NONE

isGtuAlongside

boolean isGtuAlongside(LateralDirectionality lat)
                throws ParameterException,
                       NullPointerException,
                       IllegalArgumentException

Whether there is a GTU alongside, i.e. with overlap, in an adjacent lane.

Parameters:

lat - LateralDirectionality; LEFT or RIGHT

Returns:

whether there is a GTU alongside, i.e. with overlap, in an adjacent lane

Throws:

ParameterException - if parameter is not defined

NullPointerException - if lat is null

IllegalArgumentException - if lat is NONE

getLeaders

PerceptionCollectable<HeadwayGTU,LaneBasedGTU> getLeaders(RelativeLane lane)

Set of leaders on a lane, including adjacent GTU's who's FRONT is ahead of the own vehicle FRONT. Leaders are sorted by headway value.

Parameters:

lane - RelativeLane; relative lateral lane

Returns:

set of leaders on a lane, including adjacent GTU's who's FRONT is ahead of the own vehicle FRONT

getFollowers

PerceptionCollectable<HeadwayGTU,LaneBasedGTU> getFollowers(RelativeLane lane)

Set of followers on a lane, including adjacent GTU's who's FRONT is back of the own vehicle FRONT. Follower are are sorted by distance.

Parameters:

lane - RelativeLane; relative lateral lane

Returns:

set of followers on a lane, including adjacent GTU's who's FRONT is back of the own vehicle FRONT