CrossSectionLink.java
package org.opentrafficsim.road.network.lane;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import org.djutils.event.EventType;
import org.djutils.exceptions.Throw;
import org.djutils.exceptions.Try;
import org.opentrafficsim.core.dsol.OTSSimulatorInterface;
import org.opentrafficsim.core.geometry.OTSLine3D;
import org.opentrafficsim.core.geometry.OTSPoint3D;
import org.opentrafficsim.core.network.LinkType;
import org.opentrafficsim.core.network.Network;
import org.opentrafficsim.core.network.NetworkException;
import org.opentrafficsim.core.network.OTSLink;
import org.opentrafficsim.road.network.RoadNetwork;
import org.opentrafficsim.road.network.lane.changing.LaneKeepingPolicy;
import nl.tudelft.simulation.language.d3.DirectedPoint;
/**
* A CrossSectionLink is a link with lanes where GTUs can possibly switch between lanes.
* <p>
* Copyright (c) 2013-2020 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/license.html">OpenTrafficSim License</a>.
* <p>
* $LastChangedDate: 2015-09-16 19:20:07 +0200 (Wed, 16 Sep 2015) $, @version $Revision: 1405 $, by $Author: averbraeck $,
* initial version Aug 19, 2014 <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.citg.tudelft.nl">Guus Tamminga</a>
*/
public class CrossSectionLink extends OTSLink implements Serializable
{
/** */
private static final long serialVersionUID = 20141015L;
/** List of cross-section elements. */
private final List<CrossSectionElement> crossSectionElementList = new ArrayList<>();
/** List of lanes. */
private final List<Lane> lanes = new ArrayList<>();
/** The policy to generally keep left, keep right, or keep lane. */
private final LaneKeepingPolicy laneKeepingPolicy;
/** Priority. */
// TODO per GTUDirectionality / LongitudinalDirectionality?
private Priority priority = Priority.NONE;
/** Fraction in range 0...1 to divide origin or destination flow over connectors. */
private Double demandWeight = null;
/** Line over which GTUs enter or leave the link at the start node. */
private OTSLine3D startLine;
/** Line over which GTUs enter or leave the link at the end node. */
private OTSLine3D endLine;
/**
* The (regular, not timed) event type for pub/sub indicating the addition of a Lane to a CrossSectionLink. <br>
* Payload: Object[] { String networkId, String linkId, String LaneId, Lane lane, int laneNumber } <br>
* TODO work in a different way with lane numbers to align to standard lane numbering.
*/
public static final EventType LANE_ADD_EVENT = new EventType("LINK.LANE.ADD");
/**
* The (regular, not timed) event type for pub/sub indicating the removal of a Lane from a CrossSectionLink. <br>
* Payload: Object[] { String networkId, String linkId, String LaneId } <br>
* TODO allow for the removal of a Lane; currently this is not possible.
*/
public static final EventType LANE_REMOVE_EVENT = new EventType("LINK.LANE.REMOVE");
/**
* Construction of a cross section link.
* @param network RoadNetwork; the network
* @param id String; the link id.
* @param startNode OTSRoadNode; the start node (directional).
* @param endNode OTSRoadNode; the end node (directional).
* @param linkType LinkType; the link type
* @param designLine OTSLine3D; the design line of the Link
* @param simulator OTSSimulatorInterface; the simulator on which events can be scheduled
* @param laneKeepingPolicy LaneKeepingPolicy; the policy to generally keep left, keep right, or keep lane
* @throws NetworkException if link already exists in the network, if name of the link is not unique, or if the start node
* or the end node of the link are not registered in the network.
*/
@SuppressWarnings("checkstyle:parameternumber")
public CrossSectionLink(final RoadNetwork network, final String id, final OTSRoadNode startNode, final OTSRoadNode endNode,
final LinkType linkType, final OTSLine3D designLine, final OTSSimulatorInterface simulator,
final LaneKeepingPolicy laneKeepingPolicy) throws NetworkException
{
super(network, id, startNode, endNode, linkType, designLine, simulator);
this.laneKeepingPolicy = laneKeepingPolicy;
}
/**
* Clone a CrossSectionLink for a new network.
* @param newNetwork Network; the new network to which the clone belongs
* @param newSimulator OTSSimulatorInterface; the new simulator for this network
* @param link CrossSectionLink; the link to clone from
* @throws NetworkException if link already exists in the network, if name of the link is not unique, or if the start node
* or the end node of the link are not registered in the network.
*/
protected CrossSectionLink(final RoadNetwork newNetwork, final OTSSimulatorInterface newSimulator,
final CrossSectionLink link) throws NetworkException
{
super(newNetwork, newSimulator, link);
this.laneKeepingPolicy = link.laneKeepingPolicy;
for (CrossSectionElement cse : link.crossSectionElementList)
{
cse.clone(this, newSimulator);
// the CrossSectionElement will add itself to the Link (OTS-237)
}
}
/** {@inheritDoc} */
@Override
public RoadNetwork getNetwork()
{
return (RoadNetwork) super.getNetwork();
}
/**
* Add a cross section element at the end of the list. <br>
* <b>Note:</b> LEFT is seen as a positive lateral direction, RIGHT as a negative lateral direction.
* @param cse CrossSectionElement; the cross section element to add.
*/
protected final void addCrossSectionElement(final CrossSectionElement cse)
{
this.crossSectionElementList.add(cse);
if (cse instanceof Lane)
{
this.lanes.add((Lane) cse);
fireEvent(LANE_ADD_EVENT,
new Object[] { getNetwork().getId(), getId(), cse.getId(), (Lane) cse, this.lanes.indexOf(cse) });
}
}
/**
* Retrieve a safe copy of the cross section element list.
* @return List<CrossSectionElement>; the cross section element list.
*/
public final List<CrossSectionElement> getCrossSectionElementList()
{
return this.crossSectionElementList == null ? new ArrayList<>() : new ArrayList<>(this.crossSectionElementList);
}
/**
* Retrieve the lane keeping policy.
* @return LaneKeepingPolicy; the lane keeping policy on this CrossSectionLink
*/
public final LaneKeepingPolicy getLaneKeepingPolicy()
{
return this.laneKeepingPolicy;
}
/**
* Find a cross section element with a specified id.
* @param id String; the id to search for
* @return CrossSectionElement; the cross section element with the given id, or null if not found
*/
public final CrossSectionElement getCrossSectionElement(final String id)
{
for (CrossSectionElement cse : this.crossSectionElementList)
{
if (cse.getId().equals(id))
{
return cse;
}
}
return null;
}
/**
* Return a safe copy of the list of lanes of this CrossSectionLink.
* @return List<Lane>; the list of lanes.
*/
public final List<Lane> getLanes()
{
return this.lanes == null ? new ArrayList<>() : new ArrayList<>(this.lanes);
}
/**
* @return priority.
*/
public final Priority getPriority()
{
return this.priority;
}
/**
* @param priority Priority; set priority.
*/
public final void setPriority(final Priority priority)
{
this.priority = priority;
}
/**
* Sets the demand weight. This is only applicable to links of type CONNECTOR.
* @param demandWeight double; demand weight, which is any positive value
*/
public final void setDemandWeight(final double demandWeight)
{
Throw.when(demandWeight < 0.0, IllegalArgumentException.class, "Demand weight should be positive.");
Throw.when(!getLinkType().isConnector(), IllegalArgumentException.class,
"Demand weight can only be set on connectors.");
this.demandWeight = demandWeight;
}
/**
* Clears the demand weight. This is only applicable to links of type CONNECTOR.
*/
public final void clearDemandWeight()
{
this.demandWeight = null;
}
/**
* Returns the demand weight. This is only applicable to links of type CONNECTOR.
* @return Double; demand weight, any positive value, or {@code null}
*/
public final Double getDemandWeight()
{
return this.demandWeight;
}
/**
* Returns the line over which GTUs enter and leave the link at the start node.
* @return OTSLine3D; line over which GTUs enter and leave the link at the start node
*/
public OTSLine3D getStartLine()
{
if (this.startLine == null)
{
double left = Double.NaN;
double right = Double.NaN;
for (Lane lane : this.lanes)
{
double half = lane.getBeginWidth().si * .5;
if (!Double.isNaN(left))
{
left = Math.max(left, lane.getDesignLineOffsetAtBegin().si + half);
right = Math.min(right, lane.getDesignLineOffsetAtBegin().si - half);
}
else
{
left = lane.getDesignLineOffsetAtBegin().si + half;
right = lane.getDesignLineOffsetAtBegin().si - half;
}
}
OTSPoint3D start = getStartNode().getPoint();
double heading = getStartNode().getHeading() + .5 * Math.PI;
double cosHeading = Math.cos(heading);
double sinHeading = Math.sin(heading);
OTSPoint3D leftPoint = new OTSPoint3D(start.x + cosHeading * left, start.y + sinHeading * left);
OTSPoint3D rightPoint = new OTSPoint3D(start.x - cosHeading * right, start.y - sinHeading * right);
this.startLine = Try.assign(() -> new OTSLine3D(leftPoint, rightPoint), "Invalid startline on CrossSectionLink.");
}
return this.startLine;
}
/**
* Returns the line over which GTUs enter and leave the link at the end node.
* @return OTSLine3D; line over which GTUs enter and leave the link at the end node
*/
public OTSLine3D getEndLine()
{
if (this.endLine == null)
{
double left = Double.NaN;
double right = Double.NaN;
for (Lane lane : this.lanes)
{
double half = lane.getEndWidth().si * .5;
if (!Double.isNaN(left))
{
left = Math.max(left, lane.getDesignLineOffsetAtEnd().si + half);
right = Math.min(right, lane.getDesignLineOffsetAtEnd().si - half);
}
else
{
left = lane.getDesignLineOffsetAtEnd().si + half;
right = lane.getDesignLineOffsetAtEnd().si - half;
}
}
OTSPoint3D start = getEndNode().getPoint();
DirectedPoint p = Try.assign(() -> getEndNode().getLocation(), "Unexpected remote exception.");
double heading = p.getRotZ() + .5 * Math.PI;
double cosHeading = Math.cos(heading);
double sinHeading = Math.sin(heading);
OTSPoint3D leftPoint = new OTSPoint3D(start.x + cosHeading * left, start.y + sinHeading * left);
OTSPoint3D rightPoint = new OTSPoint3D(start.x + cosHeading * right, start.y + sinHeading * right);
this.endLine = Try.assign(() -> new OTSLine3D(leftPoint, rightPoint), "Invalid endline on CrossSectionLink.");
}
return this.endLine;
}
/** {@inheritDoc} */
@Override
public final String toString()
{
return "CrossSectionLink [name=" + this.getId() + ", nodes=" + getStartNode().getId() + "-" + getEndNode().getId()
+ ", crossSectionElementList=" + this.crossSectionElementList + ", lanes=" + this.lanes + ", laneKeepingPolicy="
+ this.laneKeepingPolicy + "]";
}
/** {@inheritDoc} */
@Override
@SuppressWarnings("checkstyle:designforextension")
public CrossSectionLink clone(final Network newNetwork, final OTSSimulatorInterface newSimulator) throws NetworkException
{
Throw.when(!(newNetwork instanceof RoadNetwork), NetworkException.class,
"CrossSectionLink.clone. newNetwork not of the type Roadnetwork");
return new CrossSectionLink((RoadNetwork) newNetwork, newSimulator, this);
}
/**
* Priority of a link.
* <p>
* Copyright (c) 2013-2020 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/node/13">OpenTrafficSim License</a>.
* <p>
* @version $Revision$, $LastChangedDate$, by $Author$, initial version 12 dec. 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 enum Priority
{
/** Traffic has priority. */
PRIORITY,
/** No priority. */
NONE,
/** Turn on red. */
TURN_ON_RED,
/** Yield. */
YIELD,
/** Need to stop. */
STOP,
/** Priority according to all-stop rules. */
ALL_STOP,
/** Priority at bus stop, i.e. bus has right of way if it wants to leave the bus stop. */
BUS_STOP;
/**
* Returns whether this is priority.
* @return whether this is priority
*/
public boolean isPriority()
{
return this.equals(PRIORITY);
}
/**
* Returns whether this is none.
* @return whether this is none
*/
public boolean isNone()
{
return this.equals(NONE);
}
/**
* Returns whether this is turn on red.
* @return whether this is turn on red
*/
public boolean isTurnOnRed()
{
return this.equals(TURN_ON_RED);
}
/**
* Returns whether this is yield.
* @return whether this is yield
*/
public boolean isYield()
{
return this.equals(YIELD);
}
/**
* Returns whether this is stop.
* @return whether this is stop
*/
public boolean isStop()
{
return this.equals(STOP);
}
/**
* Returns whether this is all-stop.
* @return whether this is all-stop
*/
public boolean isAllStop()
{
return this.equals(ALL_STOP);
}
/**
* Returns whether this is bus stop.
* @return whether this is bus stop
*/
public boolean isBusStop()
{
return this.equals(BUS_STOP);
}
}
}