org.opentrafficsim.road.network.lane

Class CrossSectionLink

java.lang.Object

nl.tudelft.simulation.event.EventProducer

org.opentrafficsim.core.network.OTSLink

org.opentrafficsim.road.network.lane.CrossSectionLink

All Implemented Interfaces:

Serializable, Locatable, EventProducerInterface, Identifiable, Drawable, Link

public class CrossSectionLink
extends OTSLink
implements Serializable

A CrossSectionLink is a link with lanes where GTUs can possibly switch between lanes.

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-09-16 19:20:07 +0200 (Wed, 16 Sep 2015) $, @version $Revision: 1405 $, by $Author: averbraeck $, initial version Aug 19, 2014

Author:

Alexander Verbraeck, Peter Knoppers, Guus Tamminga

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CrossSectionLink.Priority Priority of a link.

Field Summary

Fields

Modifier and Type	Field and Description
static EventType	LANE_ADD_EVENT The (regular, not timed) event type for pub/sub indicating the addition of a Lane to a CrossSectionLink.
static EventType	LANE_REMOVE_EVENT The (regular, not timed) event type for pub/sub indicating the removal of a Lane from a CrossSectionLink.

Fields inherited from class nl.tudelft.simulation.event.EventProducer

listeners

Fields inherited from interface org.opentrafficsim.core.network.Link

GTU_ADD_EVENT, GTU_REMOVE_EVENT

Fields inherited from interface nl.tudelft.simulation.event.EventProducerInterface

FIRST_POSITION, LAST_POSITION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CrossSectionLink(Network newNetwork, OTSSimulatorInterface newSimulator, CrossSectionLink link) Clone a CrossSectionLink for a new network.
	CrossSectionLink(Network network, String id, Node startNode, Node endNode, LinkType linkType, OTSLine3D designLine, OTSSimulatorInterface simulator, LaneKeepingPolicy laneKeepingPolicy) Construction of a cross section link.

Method Summary

Modifier and Type	Method and Description
protected void	addCrossSectionElement(CrossSectionElement cse) Add a cross section element at the end of the list.
void	clearDemandWeight() Clears the demand weight.
CrossSectionLink	clone(Network newNetwork, OTSSimulatorInterface newSimulator)
CrossSectionElement	getCrossSectionElement(String id) Find a cross section element with a specified id.
List<CrossSectionElement>	getCrossSectionElementList() Retrieve a safe copy of the cross section element list.
Double	getDemandWeight() Returns the demand weight.
LaneKeepingPolicy	getLaneKeepingPolicy() Retrieve the lane keeping policy.
List<Lane>	getLanes() Return a safe copy of the list of lanes of this CrossSectionLink.
CrossSectionLink.Priority	getPriority()
void	setDemandWeight(double demandWeight) Sets the demand weight.
void	setPriority(CrossSectionLink.Priority priority)
String	toString()

Methods inherited from class org.opentrafficsim.core.network.OTSLink

addGTU, equals, getBounds, getDesignLine, getDirectionality, getEndNode, getGTUCount, getGTUs, getId, getLength, getLinkType, getLocation, getNetwork, getSimulator, getStartNode, hashCode, removeGTU

Methods inherited from class nl.tudelft.simulation.event.EventProducer

addListener, addListener, addListener, addListener, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, removeAllListeners, removeAllListeners, removeListener

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LANE_ADD_EVENT

public static final EventType LANE_ADD_EVENT

The (regular, not timed) event type for pub/sub indicating the addition of a Lane to a CrossSectionLink.
Payload: Object[] { String networkId, String linkId, String LaneId, Lane lane, int laneNumber }
TODO work in a different way with lane numbers to align to standard lane numbering.

LANE_REMOVE_EVENT

public static final EventType LANE_REMOVE_EVENT

The (regular, not timed) event type for pub/sub indicating the removal of a Lane from a CrossSectionLink.
Payload: Object[] { String networkId, String linkId, String LaneId }
TODO allow for the removal of a Lane; currently this is not possible.

Constructor Detail

CrossSectionLink

public CrossSectionLink(Network network,
                        String id,
                        Node startNode,
                        Node endNode,
                        LinkType linkType,
                        OTSLine3D designLine,
                        OTSSimulatorInterface simulator,
                        LaneKeepingPolicy laneKeepingPolicy)
                 throws NetworkException

Construction of a cross section link.

Parameters:

network - Network; the network

id - String; the link id.

startNode - Node; the start node (directional).

endNode - Node; the end node (directional).

linkType - LinkType; the link type

designLine - OTSLine3D; the design line of the Link

simulator - OTSSimulatorInterface; the simulator on which events can be scheduled

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.

CrossSectionLink

protected CrossSectionLink(Network newNetwork,
                           OTSSimulatorInterface newSimulator,
                           CrossSectionLink link)
                    throws NetworkException

Clone a CrossSectionLink for a new network.

Parameters:

newNetwork - Network; the new network to which the clone belongs

newSimulator - OTSSimulatorInterface; the new simulator for this network

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.

Method Detail

addCrossSectionElement

protected final void addCrossSectionElement(CrossSectionElement cse)

Add a cross section element at the end of the list.
Note: LEFT is seen as a positive lateral direction, RIGHT as a negative lateral direction.

Parameters:

cse - CrossSectionElement; the cross section element to add.

getCrossSectionElementList

public final List<CrossSectionElement> getCrossSectionElementList()

Retrieve a safe copy of the cross section element list.

Returns:

List<CrossSectionElement>; the cross section element list.

getLaneKeepingPolicy

public final LaneKeepingPolicy getLaneKeepingPolicy()

Retrieve the lane keeping policy.

Returns:

LaneKeepingPolicy; the lane keeping policy on this CrossSectionLink

getCrossSectionElement

public final CrossSectionElement getCrossSectionElement(String id)

Find a cross section element with a specified id.

Parameters:

id - String; the id to search for

Returns:

CrossSectionElement; the cross section element with the given id, or null if not found

getLanes

public final List<Lane> getLanes()

Return a safe copy of the list of lanes of this CrossSectionLink.

Returns:

List<Lane>; the list of lanes.

getPriority

public final CrossSectionLink.Priority getPriority()

Returns:

priority.

setPriority

public final void setPriority(CrossSectionLink.Priority priority)

Parameters:

priority - Priority; set priority.

setDemandWeight

public final void setDemandWeight(double demandWeight)

Sets the demand weight. This is only applicable to links of type CONNECTOR.

Parameters:

demandWeight - double; demand weight, which is any positive value

clearDemandWeight

public final void clearDemandWeight()

Clears the demand weight. This is only applicable to links of type CONNECTOR.

getDemandWeight

public final Double getDemandWeight()

Returns the demand weight. This is only applicable to links of type CONNECTOR.

Returns:

Double; demand weight, any positive value, or null

toString

public final String toString()

Overrides:

toString in class OTSLink

clone

public CrossSectionLink clone(Network newNetwork,
                              OTSSimulatorInterface newSimulator)
                       throws NetworkException

Overrides:

clone in class OTSLink

Throws:

NetworkException