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 GTU in front; either time stamped or just the information
• backward headway and first 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 GTUs on the left or right; either time stamped or just the information
• 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()
HeadwayGTU	getBackwardHeadwayGTU()
HeadwayGTU	getForwardHeadwayGTU()
LaneBasedGTU	getGTU()
Collection<HeadwayGTU>	getNeighboringGTUsLeft()
Collection<HeadwayGTU>	getNeighboringGTUsRight()
Set<LaneBasedGTU>	getParallelGTUsLeft()
Set<LaneBasedGTU>	getParallelGTUsRight()
org.djunits.value.vdouble.scalar.Speed	getSpeedLimit()
TimeStampedObject<Map<Lane,Set<Lane>>>	getTimeStampedAccessibleAdjacentLanesLeft()
TimeStampedObject<Map<Lane,Set<Lane>>>	getTimeStampedAccessibleAdjacentLanesRight()
TimeStampedObject<HeadwayGTU>	getTimeStampedBackwardHeadwayGTU()
TimeStampedObject<HeadwayGTU>	getTimeStampedForwardHeadwayGTU()
TimeStampedObject<Collection<HeadwayGTU>>	getTimeStampedNeighboringGTUsLeft()
TimeStampedObject<Collection<HeadwayGTU>>	getTimeStampedNeighboringGTUsRight()
TimeStampedObject<Set<LaneBasedGTU>>	getTimeStampedParallelGTUsLeft()
TimeStampedObject<Set<LaneBasedGTU>>	getTimeStampedParallelGTUsRight()
TimeStampedObject<Set<org.opentrafficsim.core.perception.PerceivedObject>>	getTimeStampedPerceivedObjects()
TimeStampedObject<org.djunits.value.vdouble.scalar.Speed>	getTimeStampedSpeedLimit()
Collection<HeadwayGTU>	neighboringGTUCollection(org.opentrafficsim.core.network.LateralDirectionality lateralDirection)
Set<LaneBasedGTU>	parallelGTUs(org.opentrafficsim.core.network.LateralDirectionality lateralDirection)
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	updateBackwardHeadwayGTU() Update who's behind us and how far away the nearest GTU is.
void	updateForwardHeadwayGTU() Update who's in front of us and how far away the nearest GTU is.
void	updateLaneTrafficLeft() Update the information about the GTUs left of our GTU, and behind us or ahead on the left hand side.
void	updateLaneTrafficRight() Update the information about the GTUs right of our GTU, and behind us or ahead on the left hand side.
void	updateParallelGTUsLeft() Update the information about the GTUs parallel to our GTU on the left side.
void	updateParallelGTUsRight() Update the information about the 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, 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

getForwardHeadwayGTU

HeadwayGTU getForwardHeadwayGTU()

Returns:

forwardHeadwayGTU, the forward headway and first GTU in front

getBackwardHeadwayGTU

HeadwayGTU getBackwardHeadwayGTU()

Returns:

backwardHeadwayGTU, the backward headway and first 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

getNeighboringGTUsLeft

Collection<HeadwayGTU> getNeighboringGTUsLeft()

Returns:

neighboringGTUsLeft, the GTUs in parallel, in front and behind on the left neighboring lane, with their headway relative to our GTU

getNeighboringGTUsRight

Collection<HeadwayGTU> getNeighboringGTUsRight()

Returns:

neighboringGTUsRight, the GTUs in parallel, in front and behind on the right neighboring lane, with their headway relative to our GTU

getParallelGTUsLeft

Set<LaneBasedGTU> getParallelGTUsLeft()

Returns:

parallelGTUsLeft, the parallel GTUs on the left

getParallelGTUsRight

Set<LaneBasedGTU> getParallelGTUsRight()

Returns:

parallelGTUsRight, the parallel GTUs on the right

getSpeedLimit

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

Returns:

speedLimit

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

parallelGTUs

Set<LaneBasedGTU> parallelGTUs(org.opentrafficsim.core.network.LateralDirectionality lateralDirection)

Parameters:

lateralDirection - the direction to return the parallel GTU map for

Returns:

the parallel GTU map for the given direction

neighboringGTUCollection

Collection<HeadwayGTU> neighboringGTUCollection(org.opentrafficsim.core.network.LateralDirectionality lateralDirection)

Parameters:

lateralDirection - the direction to return the neighboring GTU collection for

Returns:

the neighboring GTU collection for the given direction

getTimeStampedForwardHeadwayGTU

TimeStampedObject<HeadwayGTU> getTimeStampedForwardHeadwayGTU()

Returns:

TimeStamped forwardHeadwayGTU, the forward headway and first GTU in front

getTimeStampedBackwardHeadwayGTU

TimeStampedObject<HeadwayGTU> getTimeStampedBackwardHeadwayGTU()

Returns:

TimeStamped backwardHeadwayGTU, the backward headway and first GTU behind

getTimeStampedAccessibleAdjacentLanesLeft

TimeStampedObject<Map<Lane,Set<Lane>>> getTimeStampedAccessibleAdjacentLanesLeft()

Returns:

TimeStamped accessibleAdjacentLanesLeft, the accessible adjacent lanes on the left

getTimeStampedAccessibleAdjacentLanesRight

TimeStampedObject<Map<Lane,Set<Lane>>> getTimeStampedAccessibleAdjacentLanesRight()

Returns:

TimeStamped accessibleAdjacentLanesRight, the accessible adjacent lanes on the right

getTimeStampedNeighboringGTUsLeft

TimeStampedObject<Collection<HeadwayGTU>> getTimeStampedNeighboringGTUsLeft()

Returns:

TimeStamped neighboringGTUsLeft, the GTUs in parallel, in front and behind on the left neighboring lane, with their headway relative to our GTU

getTimeStampedNeighboringGTUsRight

TimeStampedObject<Collection<HeadwayGTU>> getTimeStampedNeighboringGTUsRight()

Returns:

TimeStamped neighboringGTUsRight, the GTUs in parallel, in front and behind on the right neighboring lane, with their headway relative to our GTU

getTimeStampedParallelGTUsLeft

TimeStampedObject<Set<LaneBasedGTU>> getTimeStampedParallelGTUsLeft()

Returns:

TimeStamped parallelGTUsLeft, the parallel GTUs on the left

getTimeStampedParallelGTUsRight

TimeStampedObject<Set<LaneBasedGTU>> getTimeStampedParallelGTUsRight()

Returns:

TimeStamped parallelGTUsRight, the parallel GTUs on the right

getTimeStampedSpeedLimit

TimeStampedObject<org.djunits.value.vdouble.scalar.Speed> getTimeStampedSpeedLimit()

Returns:

TimeStamped speedLimit

getTimeStampedPerceivedObjects

TimeStampedObject<Set<org.opentrafficsim.core.perception.PerceivedObject>> getTimeStampedPerceivedObjects()
                                                                                                   throws org.opentrafficsim.core.gtu.GTUException

Returns:

TimeStamped perceived objects

Throws:

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

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.

updateForwardHeadwayGTU

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

Update who's in front of us and how far away the nearest 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.

updateBackwardHeadwayGTU

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

Update who's behind us and how far away the nearest 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.

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.

updateParallelGTUsLeft

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

Update the information about the GTUs parallel to our GTU on the left side.

Throws:

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

updateParallelGTUsRight

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

Update the information about the 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

Update the information about the 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

updateLaneTrafficRight

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

Update the information about the 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