HeadwayConflict.java
package org.opentrafficsim.road.gtu.lane.perception.headway;
import java.util.SortedSet;
import java.util.TreeSet;
import org.djunits.value.vdouble.scalar.Length;
import org.djunits.value.vdouble.scalar.Speed;
import org.opentrafficsim.core.gtu.GTUException;
import org.opentrafficsim.road.network.lane.CrossSectionLink;
import org.opentrafficsim.road.network.lane.conflict.ConflictPriority;
import org.opentrafficsim.road.network.lane.conflict.ConflictRule;
import org.opentrafficsim.road.network.lane.conflict.ConflictType;
import nl.tudelft.simulation.language.Throw;
/**
* <p>
* Copyright (c) 2013-2017 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
* BSD-style license. See <a href="http://opentrafficsim.org/docs/current/license.html">OpenTrafficSim License</a>.
* <p>
* @version $Revision$, $LastChangedDate$, by $Author$, initial version Jun 2, 2016 <br>
* @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
* @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
* @author <a href="http://www.transport.citg.tudelft.nl">Wouter Schakel</a>
*/
public class HeadwayConflict extends AbstractHeadwayCopy
{
/** */
private static final long serialVersionUID = 20160602L;
/** Conflict type. */
private final ConflictType conflictType;
/** Conflict priority. */
private final ConflictPriority conflictPriority;
/** Length of the conflict in the conflicting directions. */
private final Length conflictingLength;
/**
* Set of conflicting GTU's <i>completely</i> upstream of the <i>start</i> of the conflict ordered close to far from the
* start of the conflict. Distance and overlap info concerns the conflict.
*/
private final SortedSet<HeadwayGTU> upstreamConflictingGTUs;
/**
* Set of conflicting GTU's (partially) downstream of the <i>start</i> of the conflict ordered close to far from the start
* of conflict. Distance and overlap info concerns the conflict.
*/
private final SortedSet<HeadwayGTU> downstreamConflictingGTUs;
/** Visibility on the conflicting lane within which conflicting vehicles are visible. */
private final Length conflictingVisibility;
/** Speed limit on the conflicting lane. */
private final Speed conflictingSpeedLimit;
/** Link of conflicting conflict. */
private final CrossSectionLink conflictingLink;
/** Stop line on the own lane. */
private final HeadwayStopLine stopLine;
/** Stop line on the conflicting lane. */
private final HeadwayStopLine conflictingStopLine;
/** Type of conflict rule. */
private final Class<? extends ConflictRule> conflictRuleType;
/** Distance of traffic light upstream on conflicting lane. */
private Length conflictingTrafficLightDistance = null;
/** Whether the conflict is permitted by the traffic light. */
private boolean permitted = false;
/**
* Constructor.
* @param conflictType conflict type
* @param conflictPriority conflict priority
* @param conflictRuleType conflict rule type
* @param id id
* @param distance distance
* @param length length of the conflict
* @param conflictingLength length of the conflict on the conflicting lane
* @param upstreamConflictingGTUs conflicting GTU's upstream of the <i>start</i> of the conflict
* @param downstreamConflictingGTUs conflicting GTU's downstream of the <i>start</i> of the conflict
* @param conflictingVisibility visibility on the conflicting lane within which conflicting vehicles are visible
* @param conflictingSpeedLimit speed limit on the conflicting lane
* @param conflictingLink conflicting link
* @param stopLine stop line on the own lane
* @param conflictingStopLine stop line on the conflicting lane
* @throws GTUException when id is null, or parameters are inconsistent
*/
@SuppressWarnings("checkstyle:parameternumber")
public HeadwayConflict(final ConflictType conflictType, final ConflictPriority conflictPriority,
final Class<? extends ConflictRule> conflictRuleType, final String id, final Length distance, final Length length,
final Length conflictingLength, final SortedSet<HeadwayGTU> upstreamConflictingGTUs,
final SortedSet<HeadwayGTU> downstreamConflictingGTUs, final Length conflictingVisibility,
final Speed conflictingSpeedLimit, final CrossSectionLink conflictingLink, final HeadwayStopLine stopLine,
final HeadwayStopLine conflictingStopLine) throws GTUException
{
super(ObjectType.CONFLICT, id, distance, length);
Throw.whenNull(conflictType, "Conflict type may not be null.");
Throw.whenNull(conflictPriority, "Conflict priority may not be null.");
Throw.whenNull(conflictRuleType, "Conflict rule type may not be null.");
Throw.whenNull(id, "Conflict id may not be null.");
Throw.whenNull(distance, "Conflict distance may not be null.");
Throw.whenNull(conflictingLength, "Conflict length may not be null.");
Throw.whenNull(upstreamConflictingGTUs, "Upstreaem conflicting GTU's may not be null.");
Throw.whenNull(downstreamConflictingGTUs, "Downstream conflicting GTU's may not be null.");
Throw.whenNull(conflictingVisibility, "Conflict visibility may not be null.");
Throw.whenNull(conflictingSpeedLimit, "Conflict speed limit may not be null.");
this.conflictType = conflictType;
this.conflictPriority = conflictPriority;
this.conflictRuleType = conflictRuleType;
this.conflictingLength = conflictingLength;
this.upstreamConflictingGTUs = upstreamConflictingGTUs;
this.downstreamConflictingGTUs = downstreamConflictingGTUs;
this.conflictingVisibility = conflictingVisibility;
this.conflictingSpeedLimit = conflictingSpeedLimit;
this.conflictingLink = conflictingLink;
this.stopLine = stopLine;
this.conflictingStopLine = conflictingStopLine;
}
/**
* Constructor without stop lines.
* @param conflictType conflict type
* @param conflictPriority conflict priority
* @param conflictRuleType conflict rule type
* @param id id
* @param distance distance
* @param length length of the conflict
* @param conflictingLength length of the conflict on the conflicting lane
* @param upstreamConflictingGTUs conflicting GTU's upstream of the <i>start</i> of the conflict
* @param downstreamConflictingGTUs conflicting GTU's downstream of the <i>start</i> of the conflict
* @param conflictingVisibility visibility on the conflicting lane within which conflicting vehicles are visible
* @param conflictingSpeedLimit speed limit on the conflicting lane
* @param conflictingLink conflicting link
* @throws GTUException when id is null, or parameters are inconsistent
*/
@SuppressWarnings("checkstyle:parameternumber")
public HeadwayConflict(final ConflictType conflictType, final ConflictPriority conflictPriority,
final Class<? extends ConflictRule> conflictRuleType, final String id, final Length distance, final Length length,
final Length conflictingLength, final SortedSet<HeadwayGTU> upstreamConflictingGTUs,
final SortedSet<HeadwayGTU> downstreamConflictingGTUs, final Length conflictingVisibility,
final Speed conflictingSpeedLimit, final CrossSectionLink conflictingLink) throws GTUException
{
this(conflictType, conflictPriority, conflictRuleType, id, distance, length, conflictingLength, upstreamConflictingGTUs,
downstreamConflictingGTUs, conflictingVisibility, conflictingSpeedLimit, conflictingLink, null, null);
}
/**
* Returns the conflict type.
* @return conflict type
*/
public final ConflictType getConflictType()
{
return this.conflictType;
}
/**
* Returns whether this is a crossing conflict.
* @return whether this is a crossing conflict
*/
public final boolean isCrossing()
{
return this.conflictType.equals(ConflictType.CROSSING);
}
/**
* Returns whether this is a merge conflict.
* @return whether this is a merge conflict
*/
public final boolean isMerge()
{
return this.conflictType.equals(ConflictType.MERGE);
}
/**
* Returns whether this is a split conflict.
* @return whether this is a split conflict
*/
public final boolean isSplit()
{
return this.conflictType.equals(ConflictType.SPLIT);
}
/**
* Returns the conflict priority.
* @return conflict priority
*/
public final ConflictPriority getConflictPriority()
{
return this.conflictPriority;
}
/**
* Returns the length of the conflict on the conflicting lane.
* @return length of the conflict on the conflicting lane
*/
public final Length getConflictingLength()
{
return this.conflictingLength;
}
/**
* Returns a set of conflicting GTU's upstream of the <i>start</i> of the conflict ordered close to far from the conflict.
* @return set of conflicting GTU's upstream of the <i>start</i> of the conflict ordered close to far from the conflict
*/
public final SortedSet<HeadwayGTU> getUpstreamConflictingGTUs()
{
return new TreeSet<>(this.upstreamConflictingGTUs);
}
/**
* Returns a set of conflicting GTU's downstream of the <i>start</i> of the conflict ordered close to far from the conflict.
* Distance is given relative to the <i>end</i> of the conflict, or null for conflicting vehicles on the conflict. In the
* latter case the overlap is used.
* @return set of conflicting GTU's downstream of the <i>start</i> of the conflict ordered close to far from the conflict
*/
public final SortedSet<HeadwayGTU> getDownstreamConflictingGTUs()
{
return new TreeSet<>(this.downstreamConflictingGTUs);
}
/**
* Returns the visibility on the conflicting lane within which conflicting vehicles are visible. All upstream conflicting
* GTUs have a distance smaller than the visibility. Depending on a limited visibility, a certain (lower) speed may be
* required while approaching the conflict.
* @return visibility on the conflicting lane within which conflicting vehicles are visible
*/
public final Length getConflictingVisibility()
{
return this.conflictingVisibility;
}
/**
* Returns the speed limit on the conflicting lane.
* @return speed limit on the conflicting lane
*/
public final Speed getConflictingSpeedLimit()
{
return this.conflictingSpeedLimit;
}
/**
* Returns the conflicting link.
* @return the conflicting link
*/
public final CrossSectionLink getConflictingLink()
{
return this.conflictingLink;
}
/**
* Returns the stop line.
* @return stop line
*/
public final HeadwayStopLine getStopLine()
{
return this.stopLine;
}
/**
* Returns the stop line on the conflicting lane.
* @return stop line
*/
public final HeadwayStopLine getConflictingStopLine()
{
return this.conflictingStopLine;
}
/**
* Returns the conflict rule type.
* @return conflict rule type
*/
public Class<? extends ConflictRule> getConflictRuleType()
{
return this.conflictRuleType;
}
/**
* Returns the distance of a traffic light upstream on the conflicting lane.
* @return distance of a traffic light upstream on the conflicting lane.
*/
public Length getConflictingTrafficLightDistance()
{
return this.conflictingTrafficLightDistance;
}
/**
* Whether the conflict is permitted by the traffic light.
* @return whether the conflict is permitted by the traffic light
*/
public boolean isPermitted()
{
return this.permitted;
}
/**
* Set the distance of a traffic light upstream on the conflicting lane.
* @param trafficLightDistance distance of a traffic light upstream on the conflicting lane.
* @param permittedConflict whether the conflict is permitted by the traffic light
*/
public void setConflictingTrafficLight(final Length trafficLightDistance, final boolean permittedConflict)
{
this.conflictingTrafficLightDistance = trafficLightDistance;
this.permitted = permittedConflict;
}
/** {@inheritDoc} */
public final String toString()
{
return String.format("Headway %s to object %s of type %s", getDistance(), getId(), getObjectType());
}
}