org.opentrafficsim.road.network.lane.changing

Class OvertakingConditions.LeftSet

java.lang.Object

org.opentrafficsim.road.network.lane.changing.OvertakingConditions.LeftSet

All Implemented Interfaces:

Serializable, OvertakingConditions

Enclosing interface:

OvertakingConditions

public static class OvertakingConditions.LeftSet
extends Object
implements OvertakingConditions, Serializable

Provide a collection of GTUs that can overtake another collection of GTUs on the left side, but not vice versa. Example: {CAR, TRUCK, BUS} can overtake {BICYCLE, SCOOTER}, or {CAR, TRUCK, BUS} can overtake {CAR, TRUCK, BUS, BICYCLE, SCOOTER}. In the latter case, cars, trucks and busses can overtake all other GTUs, but bicycles and scooters cannot overtake cars, trucks or busses. Another example is a lane where cars and motors can overtake all other road users, but trucks are not allowed to overtake. In that case, we would allow {CAR, MOTOR} to overtake {ALL} or {CAR, MOTOR} to overtake {CAR, MOTOR, TRUCK} in that lane.
TODO: All these "Right/LeftSet" classes should probably use Compatibility instead of full sets.

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.

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

Author:

Alexander Verbraeck

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.opentrafficsim.road.network.lane.changing.OvertakingConditions

OvertakingConditions.LeftAlwaysRightSpeed, OvertakingConditions.LeftAndRight, OvertakingConditions.LeftOnly, OvertakingConditions.LeftSet, OvertakingConditions.LeftSetRightSpeed, OvertakingConditions.None, OvertakingConditions.RightAlwaysLeftSpeed, OvertakingConditions.RightOnly, OvertakingConditions.RightSet, OvertakingConditions.RightSetLeftSpeed, OvertakingConditions.SameLaneBoth, OvertakingConditions.SameLaneLeft, OvertakingConditions.SameLaneRight

Constructor Summary

Constructors

Constructor and Description
LeftSet(Collection<GTUType> overtakingGTUTypes, Collection<GTUType> overtakenGTUTYpes) Provide a collection of GTUs that can overtake another collection of GTUs on the left, but not vice versa.

Method Summary

Modifier and Type	Method and Description
OvertakingDirection	checkOvertaking(Lane lane, LaneBasedGTU gtu, LaneBasedGTU leaderGTU) Implementation of the overtaking conditions.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LeftSet

public LeftSet(Collection<GTUType> overtakingGTUTypes,
               Collection<GTUType> overtakenGTUTYpes)

Provide a collection of GTUs that can overtake another collection of GTUs on the left, but not vice versa. Example: {CAR, TRUCK, BUS} can overtake {BICYCLE, SCOOTER}, or {CAR, TRUCK, BUS} can overtake {CAR, TRUCK, BUS, BICYCLE, SCOOTER}, or {CAR, TRUCK, BUS} can overtake {TRACTOR}.

Parameters:

overtakingGTUTypes - Collection<GTUType>; the GTUs that can overtake a set of other GTUs, e.g., CAR, TRUCK.

overtakenGTUTYpes - Collection<GTUType>; the GTUs that can be overtaken, e.g., BICYCLE, SCOOTER.

Method Detail

checkOvertaking

public final OvertakingDirection checkOvertaking(Lane lane,
                                                 LaneBasedGTU gtu,
                                                 LaneBasedGTU leaderGTU)

Implementation of the overtaking conditions. E.g., is a car allowed on this road to overtake a tractor? If so, on which side(s)?

Specified by:

checkOvertaking in interface OvertakingConditions

Parameters:

lane - Lane; the lane for which to evaluate the overtaking conditions

gtu - LaneBasedGTU; the GTU that might overtake another GTU

leaderGTU - LaneBasedGTU; the GTU in front of the GTU that might want to overtake

Returns:

an overtaking direction: LEFT, RIGHT, BOTH or NONE

toString

public final String toString()

Overrides:

toString in class Object