org.opentrafficsim.road.network.lane

Class RoadMarkerAlong

java.lang.Object

nl.tudelft.simulation.event.EventProducer

org.opentrafficsim.road.network.lane.CrossSectionElement

org.opentrafficsim.road.network.lane.RoadMarkerAlong

All Implemented Interfaces:

Serializable, nl.tudelft.simulation.dsol.animation.Locatable, nl.tudelft.simulation.event.EventProducerInterface

Direct Known Subclasses:

Barrier, Stripe

public abstract class RoadMarkerAlong
extends CrossSectionElement

Copyright (c) 2013-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2015-09-03 13:38:01 +0200 (Thu, 03 Sep 2015) $, @version $Revision: 1378 $, by $Author: averbraeck $, initial version Oct 25, 2014

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields inherited from class org.opentrafficsim.road.network.lane.CrossSectionElement

crossSectionSlices, length, parentLink

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

listeners

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

FIRST_POSITION, LAST_POSITION

Constructor Summary

Constructors

Modifier	Constructor and Description
	RoadMarkerAlong(CrossSectionLink parentLink, org.djunits.value.vdouble.scalar.Length lateralCenterPosition, org.djunits.value.vdouble.scalar.Length width) Note: LEFT is seen as a positive lateral direction, RIGHT as a negative lateral direction, with the direction from the StartNode towards the EndNode as the longitudinal direction.
	RoadMarkerAlong(CrossSectionLink parentLink, org.djunits.value.vdouble.scalar.Length startCenterPosition, org.djunits.value.vdouble.scalar.Length endCenterPosition, org.djunits.value.vdouble.scalar.Length beginWidth, org.djunits.value.vdouble.scalar.Length endWidth) Note: LEFT is seen as a positive lateral direction, RIGHT as a negative lateral direction, with the direction from the StartNode towards the EndNode as the longitudinal direction.
	RoadMarkerAlong(CrossSectionLink parentLink, List<CrossSectionSlice> crossSectionSlices) Note: LEFT is seen as a positive lateral direction, RIGHT as a negative lateral direction, with the direction from the StartNode towards the EndNode as the longitudinal direction.
protected	RoadMarkerAlong(CrossSectionLink newCrossSectionLink, org.opentrafficsim.core.dsol.OTSSimulatorInterface newSimulator, boolean animation, RoadMarkerAlong cse) Clone a RoadMarkerAlong for a new network.

Method Summary

Modifier and Type	Method and Description
void	addPermeability(org.opentrafficsim.core.gtu.GTUType gtuType, org.opentrafficsim.core.network.LateralDirectionality lateralDirection) Add lateral permeability for a GTU type in the direction of the design line of the overarching CrossSectionLink.
protected Map<org.opentrafficsim.core.gtu.GTUType,Set<org.opentrafficsim.core.network.LateralDirectionality>>	getPermeabilityMap()
protected double	getZ() Retrieve the Z offset (used to determine what covers what when drawing).
boolean	isPermeable(org.opentrafficsim.core.gtu.GTUType gtuType, org.opentrafficsim.core.network.LateralDirectionality lateralDirection)

Methods inherited from class org.opentrafficsim.road.network.lane.CrossSectionElement

clone, constructContour, equals, getBeginWidth, getBounds, getCenterLine, getContour, getDesignLineOffsetAtBegin, getDesignLineOffsetAtEnd, getEndWidth, getId, getLateralBoundaryPosition, getLateralBoundaryPosition, getLateralCenterPosition, getLateralCenterPosition, getLength, getLocation, getParentLink, getWidth, getWidth, hashCode, toString

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

Constructor Detail

RoadMarkerAlong

public RoadMarkerAlong(CrossSectionLink parentLink,
                       org.djunits.value.vdouble.scalar.Length startCenterPosition,
                       org.djunits.value.vdouble.scalar.Length endCenterPosition,
                       org.djunits.value.vdouble.scalar.Length beginWidth,
                       org.djunits.value.vdouble.scalar.Length endWidth)
                throws org.opentrafficsim.core.geometry.OTSGeometryException,
                       org.opentrafficsim.core.network.NetworkException

Note: LEFT is seen as a positive lateral direction, RIGHT as a negative lateral direction, with the direction from the StartNode towards the EndNode as the longitudinal direction.

Parameters:

parentLink - Cross Section Link to which the element belongs.

startCenterPosition - the lateral start position compared to the linear geometry of the Cross Section Link at the start of the road marker.

endCenterPosition - the lateral end position compared to the linear geometry of the Cross Section Link at the end of the road marker.

beginWidth - start width, positioned symmetrically around the lateral start position.

endWidth - end width, positioned symmetrically around the lateral end position.

Throws:

org.opentrafficsim.core.geometry.OTSGeometryException - when creation of the center line or contour geometry fails

org.opentrafficsim.core.network.NetworkException - when id equal to null or not unique

RoadMarkerAlong

public RoadMarkerAlong(CrossSectionLink parentLink,
                       org.djunits.value.vdouble.scalar.Length lateralCenterPosition,
                       org.djunits.value.vdouble.scalar.Length width)
                throws org.opentrafficsim.core.geometry.OTSGeometryException,
                       org.opentrafficsim.core.network.NetworkException

Note: LEFT is seen as a positive lateral direction, RIGHT as a negative lateral direction, with the direction from the StartNode towards the EndNode as the longitudinal direction.

Parameters:

parentLink - Cross Section Link to which the element belongs.

lateralCenterPosition - the lateral start position compared to the linear geometry of the Cross Section Link.

width - start width, positioned symmetrically around the lateral start position.

Throws:

org.opentrafficsim.core.geometry.OTSGeometryException - when creation of the center line or contour geometry fails

org.opentrafficsim.core.network.NetworkException - when id equal to null or not unique

RoadMarkerAlong

public RoadMarkerAlong(CrossSectionLink parentLink,
                       List<CrossSectionSlice> crossSectionSlices)
                throws org.opentrafficsim.core.geometry.OTSGeometryException,
                       org.opentrafficsim.core.network.NetworkException

Note: LEFT is seen as a positive lateral direction, RIGHT as a negative lateral direction, with the direction from the StartNode towards the EndNode as the longitudinal direction.

Parameters:

parentLink - Cross Section Link to which the element belongs.

crossSectionSlices - The offsets and widths at positions along the line, relative to the design line of the parent link. If there is just one with and offset, there should just be one element in the list with Length = 0. If there are more slices, the last one should be at the length of the design line. If not, a NetworkException is thrown.

Throws:

org.opentrafficsim.core.geometry.OTSGeometryException - when creation of the center line or contour geometry fails

org.opentrafficsim.core.network.NetworkException - when id equal to null or not unique

RoadMarkerAlong

protected RoadMarkerAlong(CrossSectionLink newCrossSectionLink,
                          org.opentrafficsim.core.dsol.OTSSimulatorInterface newSimulator,
                          boolean animation,
                          RoadMarkerAlong cse)
                   throws org.opentrafficsim.core.network.NetworkException

Clone a RoadMarkerAlong for a new network.

Parameters:

newCrossSectionLink - the new link to which the clone belongs

newSimulator - the new simulator for this network

animation - whether to (re)create animation or not

cse - the element to clone from

Throws:

org.opentrafficsim.core.network.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

getZ

protected final double getZ()

Retrieve the Z offset (used to determine what covers what when drawing).

Specified by:

getZ in class CrossSectionElement

Returns:

double; the Z-offset for drawing (what's on top, what's underneath).

addPermeability

public final void addPermeability(org.opentrafficsim.core.gtu.GTUType gtuType,
                                  org.opentrafficsim.core.network.LateralDirectionality lateralDirection)

Add lateral permeability for a GTU type in the direction of the design line of the overarching CrossSectionLink. Therefore, the lateral directionality of one-sided permeability has to be switched for left lanes. This is done because the CrossSectionLink has no idea in which direction vehicles will be moving. On a 1+1 lane road with overtaking possibilities, the longitudinal directionality of both lanes will be BOTH. Example:

 Suppose the design line runs from left to right.
 
 =========================
 
 LANE 1L (BACKWARD)         GTUs are allowed to move to lane 2L 
                            Permeability RIGHT is true, although vehicles will go to the LEFT...
 -------------------------  
 =========================
 
 LANE 2L (BACKWARD)         GTUs are NOT allowed to move to lane 1L nor to lane 2R
                            No permeability defined (empty set)
 =========================
 =========================
 
 LANE 2R (FORWARD)          GTUs are NOT allowed to move to lane 1R nor to lane 2L
                            No permeability defined (empty set)
 =========================
 -------------------------
 
 LANE 1R (FORWARD)          GTUs are allowed to move to lane 2R
                            Permeability LEFT is true
 =========================
 

Note: GTUType.ALL can be used to set permeability for all types of GTU at once.

Parameters:

gtuType - GTU type to add permeability for.

lateralDirection - direction to add (LEFT or RIGHT) compared to the direction of the design line.

isPermeable

public final boolean isPermeable(org.opentrafficsim.core.gtu.GTUType gtuType,
                                 org.opentrafficsim.core.network.LateralDirectionality lateralDirection)

Parameters:

gtuType - GTU type to look for.

lateralDirection - direction to look for (LEFT or RIGHT) compared to the direction of the design line.

Returns:

whether the road marker is permeable for the GTU type.

getPermeabilityMap

protected final Map<org.opentrafficsim.core.gtu.GTUType,Set<org.opentrafficsim.core.network.LateralDirectionality>> getPermeabilityMap()

Returns:

permeabilityMap for internal use in (sub)classes.