1 package org.opentrafficsim.road.network.lane.conflict;
2
3 import java.util.LinkedHashMap;
4 import java.util.Map;
5
6 import org.djunits.value.vdouble.scalar.Length;
7 import org.djutils.draw.point.OrientedPoint2d;
8 import org.djutils.exceptions.Throw;
9 import org.opentrafficsim.road.network.lane.CrossSectionLink.Priority;
10 import org.opentrafficsim.road.network.lane.Lane;
11
12 /**
13 * Default determination of priority based on link priority, or right-hand traffic. Note that this class is stateful as the
14 * priorities are cached. So each conflict pair should receive a separate {@code DefaultConflictRule}. This rule is only for use
15 * on merge and crossing conflicts. For split conflicts there is a separate rule {@code SplitConflictRule}.
16 * <p>
17 * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
18 * BSD-style license. See <a href="https://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
19 * </p>
20 * @author <a href="https://github.com/averbraeck">Alexander Verbraeck</a>
21 * @author <a href="https://github.com/peter-knoppers">Peter Knoppers</a>
22 * @author <a href="https://github.com/wjschakel">Wouter Schakel</a>
23 */
24 public class DefaultConflictRule implements ConflictRule
25 {
26
27 /** Priority per conflict. */
28 private Map<String, ConflictPriority> map = null;
29
30 // Throw.whenNull(priority1, "Conflict rule may not be null.");
31 // Throw.whenNull(priority2, "Conflict rule may not be null.");
32 // if (priority1.equals(ConflictPriority.SPLIT) || priority2.equals(ConflictPriority.SPLIT))
33 // {
34 // // Split with split (on split)
35 // Throw.when(!priority1.equals(ConflictPriority.SPLIT) || !priority2.equals(ConflictPriority.SPLIT),
36 // NetworkException.class, "Both conflict rules should be split for conflict type split.");
37 // }
38 // else
39 // {
40 // // Priority with give-way/stop
41 // boolean check1 = priority1.equals(ConflictPriority.PRIORITY) && !priority2.equals(ConflictPriority.GIVE_WAY)
42 // && !priority2.equals(ConflictPriority.STOP);
43 // boolean check2 = priority2.equals(ConflictPriority.PRIORITY) && !priority1.equals(ConflictPriority.GIVE_WAY)
44 // && !priority1.equals(ConflictPriority.STOP);
45 // boolean check3 =
46 // priority1.equals(ConflictPriority.GIVE_WAY) && !priority2.equals(ConflictPriority.PRIORITY);
47 // boolean check4 =
48 // priority2.equals(ConflictPriority.GIVE_WAY) && !priority1.equals(ConflictPriority.PRIORITY);
49 // boolean check5 = priority1.equals(ConflictPriority.STOP) && !priority2.equals(ConflictPriority.PRIORITY);
50 // boolean check6 = priority2.equals(ConflictPriority.STOP) && !priority1.equals(ConflictPriority.PRIORITY);
51 // Throw.when(check1 || check2 || check3 || check4 || check5 || check6, NetworkException.class,
52 // "Conflict rules need to be a combination of 'PRIORITY' and 'GIVE_WAY' or 'STOP', "
53 // + "if any of these types is used.");
54 // // All-stop with all-stop
55 // boolean check7 =
56 // priority1.equals(ConflictPriority.ALL_STOP) && !priority2.equals(ConflictPriority.ALL_STOP);
57 // boolean check8 =
58 // priority2.equals(ConflictPriority.ALL_STOP) && !priority1.equals(ConflictPriority.ALL_STOP);
59 // Throw.when(check7 || check8, NetworkException.class,
60 // "Conflict rule 'ALL_STOP' can only be combined with a conflict rule 'ALL_STOP'.");
61 // // No split
62 // Throw.when(priority1.equals(ConflictPriority.SPLIT) || priority2.equals(ConflictPriority.SPLIT),
63 // NetworkException.class, "Conflict rule 'SPLIT' may only be used on conflicts of type SPLIT.");
64 // }
65
66 @Override
67 public ConflictPriority determinePriority(final Conflict conflict)
68 {
69 if (this.map == null)
70 {
71 ConflictPriority[] conflictPriorities = getConflictRules(conflict.getLane(), conflict.getLongitudinalPosition(),
72 conflict.getOtherConflict().getLane(), conflict.getOtherConflict().getLongitudinalPosition(),
73 conflict.getConflictType());
74 this.map = new LinkedHashMap<>();
75 this.map.put(conflict.getId(), conflictPriorities[0]);
76 this.map.put(conflict.getOtherConflict().getId(), conflictPriorities[1]);
77 }
78 ConflictPriority out = this.map.get(conflict.getId());
79 Throw.when(out == null, IllegalArgumentException.class,
80 "Conflict %s is not related to a conflict that was used before in the same conflict rule.", conflict);
81 return out;
82 }
83
84 /**
85 * Determine conflict rules.
86 * @param lane1 lane 1
87 * @param longitudinalPosition1 position 1
88 * @param lane2 lane 2
89 * @param longitudinalPosition2 position 2
90 * @param conflictType conflict type
91 * @return conflict rule 1 and 2
92 */
93 private static ConflictPriority[] getConflictRules(final Lane lane1, final Length longitudinalPosition1, final Lane lane2,
94 final Length longitudinalPosition2, final ConflictType conflictType)
95 {
96 Throw.when(conflictType.equals(ConflictType.SPLIT), UnsupportedOperationException.class,
97 "DefaultConflictRule is not for use on a split conflict. Use SplitConflictRule instead.");
98 ConflictPriority[] conflictRules = new ConflictPriority[2];
99 Priority priority1 = lane1.getLink().getPriority();
100 Priority priority2 = lane2.getLink().getPriority();
101 if (priority1.isAllStop() && priority2.isAllStop())
102 {
103 conflictRules[0] = ConflictPriority.ALL_STOP;
104 conflictRules[1] = ConflictPriority.ALL_STOP;
105 }
106 else if (priority1.equals(priority2) || (priority1.isYield() && priority2.isStop())
107 || (priority2.isYield() && priority1.isStop()))
108 {
109 Throw.when(priority1.isBusStop(), IllegalArgumentException.class,
110 "Both priorities are 'bus stop', which is not allowed. Use BusStopConflictRule for bus stops.");
111 // Based on right- or left-hand traffic
112 OrientedPoint2d p1 = lane1.getCenterLine().getLocation(longitudinalPosition1);
113 OrientedPoint2d p2 = lane2.getCenterLine().getLocation(longitudinalPosition2);
114 double diff = p2.getDirZ() - p1.getDirZ();
115 while (diff > Math.PI)
116 {
117 diff -= 2 * Math.PI;
118 }
119 while (diff < -Math.PI)
120 {
121 diff += 2 * Math.PI;
122 }
123 if (diff > 0.0)
124 {
125 // 2 comes from the right
126 conflictRules[0] = priority1.isStop() ? ConflictPriority.STOP : ConflictPriority.YIELD;
127 conflictRules[1] = ConflictPriority.PRIORITY;
128 }
129 else
130 {
131 // 1 comes from the right
132 conflictRules[0] = ConflictPriority.PRIORITY;
133 conflictRules[1] = priority2.isStop() ? ConflictPriority.STOP : ConflictPriority.YIELD;
134 }
135 }
136 else if ((priority1.isPriority() || priority1.isNone()) // note, both NONE already captured
137 && (priority2.isNone() || priority2.isYield() || priority2.isStop()))
138 {
139 conflictRules[0] = ConflictPriority.PRIORITY;
140 conflictRules[1] = priority2.isStop() ? ConflictPriority.STOP : ConflictPriority.YIELD;
141 }
142 else if ((priority2.isPriority() || priority2.isNone())
143 && (priority1.isNone() || priority1.isYield() || priority1.isStop()))
144 {
145 conflictRules[0] = priority1.isStop() ? ConflictPriority.STOP : ConflictPriority.YIELD;
146 conflictRules[1] = ConflictPriority.PRIORITY;
147 }
148 else
149 {
150 throw new IllegalArgumentException(
151 "Could not sort out conflict priority from link priorities " + priority1 + " and " + priority2);
152 }
153 return conflictRules;
154 }
155
156 @Override
157 public final String toString()
158 {
159 return "DefaultConflictRule";
160 }
161
162 }