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

Class NeighborsPerception

java.lang.Object

org.opentrafficsim.core.Type<org.opentrafficsim.core.gtu.perception.AbstractPerceptionCategory>

org.opentrafficsim.core.gtu.perception.AbstractPerceptionCategory

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

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

All Implemented Interfaces:

Serializable

public class NeighborsPerception
extends LaneBasedAbstractPerceptionCategory

Perception of surrounding traffic on the own road, i.e. without crossing traffic.

Copyright (c) 2013-2016 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 Jul 22, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NeighborsPerception(LanePerception perception)

Method Summary

Modifier and Type	Method and Description
SortedSet<AbstractHeadwayGTU>	getFirstFollowers(org.opentrafficsim.core.network.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<AbstractHeadwayGTU>	getFirstLeaders(org.opentrafficsim.core.network.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.
SortedSet<AbstractHeadwayGTU>	getFollowers(RelativeLane lane) Set of followers on a lane, including adjacent GTU's who's REAR is back of the own vehicle REAR.
LanePathInfo	getLanePathInfo() Retrieve the last perceived lane path info.
SortedSet<AbstractHeadwayGTU>	getLeaders(RelativeLane lane) Set of leaders on a lane, including adjacent GTU's who's FRONT is ahead of the own vehicle FRONT.
org.opentrafficsim.core.gtu.perception.TimeStampedObject<SortedSet<AbstractHeadwayGTU>>	getTimeStampedFirstFollowers(org.opentrafficsim.core.network.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.
org.opentrafficsim.core.gtu.perception.TimeStampedObject<SortedSet<AbstractHeadwayGTU>>	getTimeStampedFirstLeaders(org.opentrafficsim.core.network.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.
org.opentrafficsim.core.gtu.perception.TimeStampedObject<SortedSet<AbstractHeadwayGTU>>	getTimeStampedFollowers(RelativeLane lane) Set of followers on a lane, including adjacent GTU's who's REAR is back of the own vehicle REAR.
org.opentrafficsim.core.gtu.perception.TimeStampedObject<LanePathInfo>	getTimeStampedLanePathInfo() Retrieve the time stamped last perceived lane path info.
org.opentrafficsim.core.gtu.perception.TimeStampedObject<SortedSet<AbstractHeadwayGTU>>	getTimeStampedLeaders(RelativeLane lane) Set of leaders on a lane, including adjacent GTU's who's FRONT is ahead of the own vehicle FRONT.
boolean	isGtuAlongside(org.opentrafficsim.core.network.LateralDirectionality lat) Whether there is a GTU alongside, i.e.
org.opentrafficsim.core.gtu.perception.TimeStampedObject<Boolean>	isGtuAlongsideTimeStamped(org.opentrafficsim.core.network.LateralDirectionality lat) Whether there is a GTU alongside, i.e.
String	toString()
void	updateAll()
void	updateFirstFollowers(org.opentrafficsim.core.network.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(org.opentrafficsim.core.network.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 REAR is back of the own vehicle REAR.
void	updateGtuAlongside(org.opentrafficsim.core.network.LateralDirectionality lat) Update whether there is a GTU alongside, i.e.
void	updateLanePathInfo()
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 class org.opentrafficsim.road.gtu.lane.perception.categories.LaneBasedAbstractPerceptionCategory

getGtu, getPerception

Methods inherited from class org.opentrafficsim.core.gtu.perception.AbstractPerceptionCategory

getTimestamp

Methods inherited from class org.opentrafficsim.core.Type

isType

Methods inherited from class java.lang.Object

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

Constructor Detail

NeighborsPerception

public NeighborsPerception(LanePerception perception)

Parameters:

perception - perception

Method Detail

updateAll

public final void updateAll()
                     throws org.opentrafficsim.core.gtu.GTUException,
                            org.opentrafficsim.core.network.NetworkException,
                            org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException

Specified by:

updateAll in class org.opentrafficsim.core.gtu.perception.AbstractPerceptionCategory

Throws:

org.opentrafficsim.core.gtu.GTUException

org.opentrafficsim.core.network.NetworkException

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException

updateFirstLeaders

public final void updateFirstLeaders(org.opentrafficsim.core.network.LateralDirectionality lat)
                              throws org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException,
                                     org.opentrafficsim.core.gtu.GTUException,
                                     org.opentrafficsim.core.network.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 - LEFT or RIGHT

Throws:

org.opentrafficsim.core.network.NetworkException - in case of a network exception

org.opentrafficsim.core.gtu.GTUException - if the GTU was not initialized

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - if a parameter was not present or out of bounds

NullPointerException - if lat is null

IllegalArgumentException - if lat is NONE

updateFirstFollowers

public final void updateFirstFollowers(org.opentrafficsim.core.network.LateralDirectionality lat)
                                throws org.opentrafficsim.core.gtu.GTUException,
                                       org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException,
                                       org.opentrafficsim.core.network.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 - LEFT or RIGHT

Throws:

org.opentrafficsim.core.network.NetworkException - in case of a network exception

org.opentrafficsim.core.gtu.GTUException - if the GTU was not initialized

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - if a parameter was not present or out of bounds

NullPointerException - if lat is null

IllegalArgumentException - if lat is NONE

updateGtuAlongside

public final void updateGtuAlongside(org.opentrafficsim.core.network.LateralDirectionality lat)
                              throws org.opentrafficsim.core.gtu.GTUException,
                                     org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException

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

Parameters:

lat - LEFT or RIGHT

Throws:

org.opentrafficsim.core.gtu.GTUException - if the GTU was not initialized

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - if parameter is not defined

NullPointerException - if lat is null

IllegalArgumentException - if lat is NONE

updateLeaders

public final void updateLeaders(RelativeLane lane)
                         throws org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException,
                                org.opentrafficsim.core.gtu.GTUException,
                                org.opentrafficsim.core.network.NetworkException

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

Parameters:

lane - relative lateral lane

Throws:

org.opentrafficsim.core.network.NetworkException - in case of a network exception

org.opentrafficsim.core.gtu.GTUException - if the GRU was not initialized

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - if a parameter was not present or out of bounds

updateFollowers

public final void updateFollowers(RelativeLane lane)
                           throws org.opentrafficsim.core.gtu.GTUException,
                                  org.opentrafficsim.core.network.NetworkException,
                                  org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException

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

Parameters:

lane - relative lateral lane

Throws:

org.opentrafficsim.core.network.NetworkException - in case of a network exception

org.opentrafficsim.core.gtu.GTUException - if the GRU was not initialized

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - if a parameter was not present or out of bounds

getFirstLeaders

public final SortedSet<AbstractHeadwayGTU> getFirstLeaders(org.opentrafficsim.core.network.LateralDirectionality lat)
                                                    throws org.opentrafficsim.core.gtu.behavioralcharacteristics.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_ _ _ _ _ _ _
 _________________
 

Parameters:

lat - LEFT or RIGHT

Returns:

list of followers on a lane

Throws:

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - if parameter is not defined

NullPointerException - if lat is null

IllegalArgumentException - if lat is NONE

getFirstFollowers

public final SortedSet<AbstractHeadwayGTU> getFirstFollowers(org.opentrafficsim.core.network.LateralDirectionality lat)
                                                      throws org.opentrafficsim.core.gtu.behavioralcharacteristics.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_ 
 _____|___________
 

Parameters:

lat - LEFT or RIGHT

Returns:

list of followers on a lane

Throws:

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - if parameter is not defined

NullPointerException - if lat is null

IllegalArgumentException - if lat is NONE

isGtuAlongside

public final boolean isGtuAlongside(org.opentrafficsim.core.network.LateralDirectionality lat)
                             throws org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException,
                                    NullPointerException,
                                    IllegalArgumentException

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

Parameters:

lat - LEFT or RIGHT

Returns:

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

Throws:

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - if parameter is not defined

NullPointerException - if lat is null

IllegalArgumentException - if lat is NONE

getLeaders

public final SortedSet<AbstractHeadwayGTU> 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 - 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

public final SortedSet<AbstractHeadwayGTU> getFollowers(RelativeLane lane)

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

Parameters:

lane - relative lateral lane

Returns:

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

getTimeStampedFirstLeaders

public final org.opentrafficsim.core.gtu.perception.TimeStampedObject<SortedSet<AbstractHeadwayGTU>> getTimeStampedFirstLeaders(org.opentrafficsim.core.network.LateralDirectionality lat)
                                                                                                                         throws org.opentrafficsim.core.gtu.behavioralcharacteristics.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_ _ _ _ _ _ _
 _________________
 

Parameters:

lat - LEFT or RIGHT

Returns:

list of followers on a lane

Throws:

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - if parameter is not defined

NullPointerException - if lat is null

IllegalArgumentException - if lat is NONE

getTimeStampedFirstFollowers

public final org.opentrafficsim.core.gtu.perception.TimeStampedObject<SortedSet<AbstractHeadwayGTU>> getTimeStampedFirstFollowers(org.opentrafficsim.core.network.LateralDirectionality lat)
                                                                                                                           throws org.opentrafficsim.core.gtu.behavioralcharacteristics.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_ 
 _____|___________
 

Parameters:

lat - LEFT or RIGHT

Returns:

list of followers on a lane

Throws:

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - if parameter is not defined

NullPointerException - if lat is null

IllegalArgumentException - if lat is NONE

isGtuAlongsideTimeStamped

public final org.opentrafficsim.core.gtu.perception.TimeStampedObject<Boolean> isGtuAlongsideTimeStamped(org.opentrafficsim.core.network.LateralDirectionality lat)
                                                                                                  throws org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException,
                                                                                                         NullPointerException,
                                                                                                         IllegalArgumentException

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

Parameters:

lat - LEFT or RIGHT

Returns:

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

Throws:

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - if parameter is not defined

NullPointerException - if lat is null

IllegalArgumentException - if lat is NONE

getTimeStampedLeaders

public final org.opentrafficsim.core.gtu.perception.TimeStampedObject<SortedSet<AbstractHeadwayGTU>> getTimeStampedLeaders(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 - relative lateral lane

Returns:

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

getTimeStampedFollowers

public final org.opentrafficsim.core.gtu.perception.TimeStampedObject<SortedSet<AbstractHeadwayGTU>> getTimeStampedFollowers(RelativeLane lane)

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

Parameters:

lane - relative lateral lane

Returns:

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

toString

public final String toString()

Overrides:

toString in class Object

updateLanePathInfo

public final void updateLanePathInfo()
                              throws org.opentrafficsim.core.gtu.GTUException,
                                     org.opentrafficsim.core.network.NetworkException,
                                     org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException

Throws:

org.opentrafficsim.core.gtu.GTUException - when the GTU was not initialized yet.

org.opentrafficsim.core.network.NetworkException - when the speed limit for a GTU type cannot be retrieved from the network.

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - in case of not being able to retrieve parameter ParameterTypes.LOOKAHEAD

getLanePathInfo

public final LanePathInfo getLanePathInfo()

Retrieve the last perceived lane path info.

Returns:

LanePathInfo

getTimeStampedLanePathInfo

public final org.opentrafficsim.core.gtu.perception.TimeStampedObject<LanePathInfo> getTimeStampedLanePathInfo()

Retrieve the time stamped last perceived lane path info.

Returns:

LanePathInfo