Package org.opentrafficsim.road.gtu.lane.tactical

Class LanePathInfo

java.lang.Object

org.opentrafficsim.road.gtu.lane.tactical.LanePathInfo

All Implemented Interfaces:

Serializable

public class LanePathInfo
extends Object
implements Serializable

This class provides the following information for an operational plan:

• the lanes to follow, with the direction to drive on them
• the starting point on the first lane
• the path to follow when staying on the same lane

Copyright (c) 2013-2023 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

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LanePathInfo(OtsLine3d path, List<Lane> laneList, Length referencePosition)

Method Summary

Modifier and Type	Method	Description
final List<Lane>	getLaneList()
final List<Lane>	getLanes()
final OtsLine3d	getPath()
final Lane	getReferenceLane()	The reference lane is the widest lane on which the reference point of the GTU is fully registered.
final Length	getReferencePosition()
final String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

LanePathInfo

public LanePathInfo(OtsLine3d path,
 List<Lane> laneList,
 Length referencePosition)

Parameters:

path - OtsLine3d; the path it the GTU keeps driving in the same lane, and follows the route if possible in the same lane. The path stops when the lane or a continuation lane does not lead in the direction of the route provided by the strategical planner.

laneList - List<Lane>; the current lane on which the reference point of the GTU is registered (if the GTU is registered on multiple lanes with the reference point, one lane is chosen where the reference point has a fractional lane position between 0.0 and 1.0), and consecutive lanes that follow the route if possible in the same lane. The list of lanes stops when a continuation lane does not lead in the direction of the route provided by the strategical planner.

referencePosition - Length; the start point on the first lane in the laneList. When this is a point that represents a GTU position, it should represent the reference point of the GTU.

Method Details

getPath

public final OtsLine3d getPath()

Returns:

path the path it the GTU keeps driving in the same lane, and follows the route if possible in the same lane. The path stops when the lane or a continuation lane does not lead in the direction of the route provided by the strategical planner.

getLaneList

public final List<Lane> getLaneList()

Returns:

laneList the current lane on which the reference point of the GTU is registered (if the GTU is registered on multiple lanes with the reference point, one lane is chosen where the reference point has a fractional lane position between 0.0 and 1.0), and consecutive lanes that follow the route if possible in the same lane. The list of lanes stops when a continuation lane does not lead in the direction of the route provided by the strategical planner. For each lane, the direction to drive is provided.

getLanes

public final List<Lane> getLanes()

Returns:

list of lanes

getReferenceLane

public final Lane getReferenceLane()

The reference lane is the widest lane on which the reference point of the GTU is fully registered.

Returns:

the reference lane on which the GTU is registered, or null if the GTU is not registered on any lane.

getReferencePosition

public final Length getReferencePosition()

Returns:

the start point on the first lane in the laneDirectionList. When this is a point that represents a GTU position, it should represent the reference point of the GTU.

toString

public final String toString()

Overrides:

toString in class Object