org.opentrafficsim.road.gtu.lane.perception

Interface LanePerception

All Superinterfaces:

org.opentrafficsim.core.gtu.perception.Perception, Serializable

All Known Implementing Classes:

AbstractLanePerception, LanePerceptionFull, LanePerceptionNone

public interface LanePerception
extends org.opentrafficsim.core.gtu.perception.Perception

Interface for perception in a lane-based model. The following information can be perceived:

• maximum speed we can use at the current location; either time stamped or just the information
• forward headway and first object (e.g., GTU) in front; either time stamped or just the information
• backward headway and first object (e.g., GTU) behind; either time stamped or just the information
• accessible adjacent lanes on the left or right; either time stamped or just the information
• parallel objects (e.g., GTUa) on the left or right; either time stamped or just the information
• Objects (e.g., GTUs) in parallel, in front and behind on the left or right neighboring lane, with their headway relative to our GTU; either time stamped or just the information

Copyright (c) 2013-2015 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Jan 30, 2016

Author:

Alexander Verbraeck, Peter Knoppers

Method Summary

Modifier and Type	Method and Description
Map<Lane,Set<Lane>>	accessibleAdjacentLaneMap(org.opentrafficsim.core.network.LateralDirectionality lateralDirection)
Map<Lane,Set<Lane>>	getAccessibleAdjacentLanesLeft()
Map<Lane,Set<Lane>>	getAccessibleAdjacentLanesRight()
Headway	getBackwardHeadway()
Headway	getForwardHeadway()
LaneBasedGTU	getGTU()
Collection<Headway>	getNeighboringHeadways(org.opentrafficsim.core.network.LateralDirectionality lateralDirection)
Collection<Headway>	getNeighboringHeadwaysLeft()
Collection<Headway>	getNeighboringHeadwaysRight()
Collection<Headway>	getParallelHeadways(org.opentrafficsim.core.network.LateralDirectionality lateralDirection)
Collection<Headway>	getParallelHeadwaysLeft()
Collection<Headway>	getParallelHeadwaysRight()
org.djunits.value.vdouble.scalar.Speed	getSpeedLimit()
org.opentrafficsim.core.gtu.perception.TimeStampedObject<Map<Lane,Set<Lane>>>	getTimeStampedAccessibleAdjacentLanesLeft()
org.opentrafficsim.core.gtu.perception.TimeStampedObject<Map<Lane,Set<Lane>>>	getTimeStampedAccessibleAdjacentLanesRight()
org.opentrafficsim.core.gtu.perception.TimeStampedObject<Headway>	getTimeStampedBackwardHeadway()
org.opentrafficsim.core.gtu.perception.TimeStampedObject<Headway>	getTimeStampedForwardHeadway()
org.opentrafficsim.core.gtu.perception.TimeStampedObject<Collection<Headway>>	getTimeStampedNeighboringHeadwaysLeft()
org.opentrafficsim.core.gtu.perception.TimeStampedObject<Collection<Headway>>	getTimeStampedNeighboringHeadwaysRight()
org.opentrafficsim.core.gtu.perception.TimeStampedObject<Collection<Headway>>	getTimeStampedParallelHeadwaysLeft()
org.opentrafficsim.core.gtu.perception.TimeStampedObject<Collection<Headway>>	getTimeStampedParallelHeadwaysRight()
org.opentrafficsim.core.gtu.perception.TimeStampedObject<org.djunits.value.vdouble.scalar.Speed>	getTimeStampedSpeedLimit()
void	setGTU(LaneBasedGTU gtu) Sets the GTU -- call this method before any call to the perceive() method!
void	updateAccessibleAdjacentLanesLeft() Build a set of Lanes that is adjacent to the given lane that this GTU can enter, for the left lateral direction.
void	updateAccessibleAdjacentLanesRight() Build a set of Lanes that is adjacent to the given lane that this GTU can enter, for the left lateral direction.
void	updateBackwardHeadway() Update who's behind us and how far away the nearest object (e.g., a GTU) is.
void	updateForwardHeadway() Update who's in front of us and how far away the nearest object (e.g., a GTU) is.
void	updateLaneTrafficLeft() Update the information about the objects (e.g., GTUs) left of our GTU, and behind us or ahead on the left hand side.
void	updateLaneTrafficRight() Update the information about the objects (e.g., GTUs) right of our GTU, and behind us or ahead on the left hand side.
void	updateParallelHeadwaysLeft() Update the information about the objects (e.g., GTUs) parallel to our GTU on the left side.
void	updateParallelHeadwaysRight() Update the information about the objects (e.g., GTUs) parallel to our GTU on the right side.
void	updateSpeedLimit() Update the perceived speed limit.

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

getPerceivedObjects, getTimeStampedPerceivedObjects, perceive

Method Detail

setGTU

void setGTU(LaneBasedGTU gtu)

Sets the GTU -- call this method before any call to the perceive() method!

Parameters:

gtu - the GTU for which this is the perception module

getGTU

LaneBasedGTU getGTU()

Returns:

the gtu for which this is the perception

getForwardHeadway

Headway getForwardHeadway()

Returns:

forwardHeadway, the forward headway and first object (e.g., a GTU) in front

getBackwardHeadway

Headway getBackwardHeadway()

Returns:

backwardHeadwayGTU, the backward headway and first object (e.g., a GTU) behind

getAccessibleAdjacentLanesLeft

Map<Lane,Set<Lane>> getAccessibleAdjacentLanesLeft()

Returns:

accessibleAdjacentLanesLeft, the accessible adjacent lanes on the left

getAccessibleAdjacentLanesRight

Map<Lane,Set<Lane>> getAccessibleAdjacentLanesRight()

Returns:

accessibleAdjacentLanesRight, the accessible adjacent lanes on the right

accessibleAdjacentLaneMap

Map<Lane,Set<Lane>> accessibleAdjacentLaneMap(org.opentrafficsim.core.network.LateralDirectionality lateralDirection)

Parameters:

lateralDirection - the direction to return the accessible adjacent lane map for

Returns:

the accessible adjacent lane map for the given direction

getNeighboringHeadwaysLeft

Collection<Headway> getNeighboringHeadwaysLeft()

Returns:

neighboringHeadwaysLeft, the objects (e.g., GTUs) in parallel, in front and behind on the left neighboring lane, with their headway relative to our GTU, and information about the status of the adjacent objects

getNeighboringHeadwaysRight

Collection<Headway> getNeighboringHeadwaysRight()

Returns:

neighboringHeadwaysRight, the objects (e.g., GTUs) in parallel, in front and behind on the right neighboring lane, with their headway relative to our GTU, and information about the status of the adjacent objects

getNeighboringHeadways

Collection<Headway> getNeighboringHeadways(org.opentrafficsim.core.network.LateralDirectionality lateralDirection)

Parameters:

lateralDirection - the direction to return the parallel headway collection for

Returns:

the the objects (e.g., GTUs) in parallel, in front and behind for the lane in the given direction, with their headway relative to our GTU, and information about the status of the adjacent objects

getParallelHeadwaysLeft

Collection<Headway> getParallelHeadwaysLeft()

Returns:

parallelHeadwaysLeft, the parallel objects (e.g., GTUs) on the left, with information about their status and parallel overlap with our GTU.

getParallelHeadwaysRight

Collection<Headway> getParallelHeadwaysRight()

Returns:

parallelHeadwaysRight, the parallel objects (e.g., GTUs) on the right, with information about their status and parallel overlap with our GTU.

getParallelHeadways

Collection<Headway> getParallelHeadways(org.opentrafficsim.core.network.LateralDirectionality lateralDirection)

Parameters:

lateralDirection - the direction to return the neighboring headway collection for

Returns:

the the parallel objects (e.g., GTUs) for the given direction, with information about their status and parallel overlap with our GTU.

getSpeedLimit

org.djunits.value.vdouble.scalar.Speed getSpeedLimit()

Returns:

speedLimit

getTimeStampedForwardHeadway

org.opentrafficsim.core.gtu.perception.TimeStampedObject<Headway> getTimeStampedForwardHeadway()

Returns:

TimeStamped forwardHeadway, the forward headway and first object (e.g., a GTU) in front

getTimeStampedBackwardHeadway

org.opentrafficsim.core.gtu.perception.TimeStampedObject<Headway> getTimeStampedBackwardHeadway()

Returns:

TimeStamped backwardHeadwayGTU, the backward headway and first object (e.g., a GTU) behind

getTimeStampedAccessibleAdjacentLanesLeft

org.opentrafficsim.core.gtu.perception.TimeStampedObject<Map<Lane,Set<Lane>>> getTimeStampedAccessibleAdjacentLanesLeft()

Returns:

TimeStamped accessibleAdjacentLanesLeft, the accessible adjacent lanes on the left

getTimeStampedAccessibleAdjacentLanesRight

org.opentrafficsim.core.gtu.perception.TimeStampedObject<Map<Lane,Set<Lane>>> getTimeStampedAccessibleAdjacentLanesRight()

Returns:

TimeStamped accessibleAdjacentLanesRight, the accessible adjacent lanes on the right

getTimeStampedNeighboringHeadwaysLeft

org.opentrafficsim.core.gtu.perception.TimeStampedObject<Collection<Headway>> getTimeStampedNeighboringHeadwaysLeft()

Returns:

TimeStamped neighboringHeadwaysLeft, the objects (e.g., GTUs) in parallel, in front and behind on the left neighboring lane, with their headway relative to our GTU, and information about the status of the adjacent objects

getTimeStampedNeighboringHeadwaysRight

org.opentrafficsim.core.gtu.perception.TimeStampedObject<Collection<Headway>> getTimeStampedNeighboringHeadwaysRight()

Returns:

TimeStamped neighboringHeadwaysRight, the objects (e.g., GTUs) in parallel, in front and behind on the right neighboring lane, with their headway relative to our GTU, and information about the status of the adjacent objects

getTimeStampedParallelHeadwaysLeft

org.opentrafficsim.core.gtu.perception.TimeStampedObject<Collection<Headway>> getTimeStampedParallelHeadwaysLeft()

Returns:

TimeStamped parallelHeadwaysLeft, the parallel objects (e.g., GTUs) on the left, with information about their status and parallel overlap with our GTU.

getTimeStampedParallelHeadwaysRight

org.opentrafficsim.core.gtu.perception.TimeStampedObject<Collection<Headway>> getTimeStampedParallelHeadwaysRight()

Returns:

TimeStamped parallelHeadwaysRight, the parallel objects (e.g., GTUs) on the right, with information about their status and parallel overlap with our GTU.

getTimeStampedSpeedLimit

org.opentrafficsim.core.gtu.perception.TimeStampedObject<org.djunits.value.vdouble.scalar.Speed> getTimeStampedSpeedLimit()

Returns:

TimeStamped speedLimit

updateForwardHeadway

void updateForwardHeadway()
                   throws org.opentrafficsim.core.gtu.GTUException,
                          org.opentrafficsim.core.network.NetworkException,
                          org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException

Update who's in front of us and how far away the nearest object (e.g., a GTU) is.

Throws:

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

org.opentrafficsim.core.network.NetworkException - when the headway cannot be determined for this GTU, usually due to routing problems.

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - when there is a parameter problem, e.g., retrieving the forwardHeadwayDistance.

updateBackwardHeadway

void updateBackwardHeadway()
                    throws org.opentrafficsim.core.gtu.GTUException,
                           org.opentrafficsim.core.network.NetworkException,
                           org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException

Update who's behind us and how far away the nearest object (e.g., a GTU) is.

Throws:

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

org.opentrafficsim.core.network.NetworkException - when the headway cannot be determined for this GTU, usually due to routing problems.

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - when there is a parameter problem, e.g., retrieving the backwardHeadwayDistance.

updateAccessibleAdjacentLanesLeft

void updateAccessibleAdjacentLanesLeft()
                                throws org.opentrafficsim.core.gtu.GTUException

Build a set of Lanes that is adjacent to the given lane that this GTU can enter, for the left lateral direction.

Throws:

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

updateAccessibleAdjacentLanesRight

void updateAccessibleAdjacentLanesRight()
                                 throws org.opentrafficsim.core.gtu.GTUException

Build a set of Lanes that is adjacent to the given lane that this GTU can enter, for the left lateral direction.

Throws:

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

updateParallelHeadwaysLeft

void updateParallelHeadwaysLeft()
                         throws org.opentrafficsim.core.gtu.GTUException

Update the information about the objects (e.g., GTUs) parallel to our GTU on the left side.

Throws:

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

updateParallelHeadwaysRight

void updateParallelHeadwaysRight()
                          throws org.opentrafficsim.core.gtu.GTUException

Update the information about the objects (e.g., GTUs) parallel to our GTU on the right side.

Throws:

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

updateLaneTrafficLeft

void updateLaneTrafficLeft()
                    throws org.opentrafficsim.core.gtu.GTUException,
                           org.opentrafficsim.core.network.NetworkException,
                           org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException

Update the information about the objects (e.g., GTUs) left of our GTU, and behind us or ahead on the left hand side.

Throws:

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

org.opentrafficsim.core.network.NetworkException - when there is an inconsistency in the lanes on this network

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - when there is a parameter problem.

updateLaneTrafficRight

void updateLaneTrafficRight()
                     throws org.opentrafficsim.core.gtu.GTUException,
                            org.opentrafficsim.core.network.NetworkException,
                            org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException

Update the information about the objects (e.g., GTUs) right of our GTU, and behind us or ahead on the left hand side.

Throws:

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

org.opentrafficsim.core.network.NetworkException - when there is an inconsistency in the lanes on this network

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - when there is a parameter problem.

updateSpeedLimit

void updateSpeedLimit()
               throws org.opentrafficsim.core.gtu.GTUException,
                      org.opentrafficsim.core.network.NetworkException

Update the perceived speed limit.

Throws:

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

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