org.opentrafficsim.core.network.lane

Class RoadMarkerAlong<LINKID,NODEID>

java.lang.Object

org.opentrafficsim.core.network.lane.CrossSectionElement<LINKID,NODEID>

org.opentrafficsim.core.network.lane.RoadMarkerAlong<LINKID,NODEID>

Type Parameters:

NODEID - the ID type of the Node, e.g., String.

LINKID - the ID type of the Link, e.g., String.

All Implemented Interfaces:

LocatableInterface

Direct Known Subclasses:

Barrier, Stripe

public abstract class RoadMarkerAlong<LINKID,NODEID>
extends CrossSectionElement<LINKID,NODEID>

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

$LastChangedDate: 2015-07-26 22:05:02 +0200 (Sun, 26 Jul 2015) $, @version $Revision: 1156 $, by $Author: averbraeck $, initial version Oct 25, 2014

Author:

Alexander Verbraeck, Peter Knoppers

Field Summary

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

beginWidth, designLineOffsetAtBegin, designLineOffsetAtEnd, endWidth, length, parentLink

Constructor Summary

Constructors

Constructor and Description
RoadMarkerAlong(CrossSectionLink<LINKID,NODEID> parentLink, DoubleScalar.Rel<LengthUnit> lateralCenterPosition, DoubleScalar.Rel<LengthUnit> beginWidth, DoubleScalar.Rel<LengthUnit> 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.

Method Summary

Modifier and Type	Method and Description
void	addPermeability(GTUType<?> gtuType, LateralDirectionality lateralDirection) Add lateral permeability for a GTU type in the direction of the design line of the overarching CrossSectionLink.
protected double	getZ()
boolean	isPermeable(GTUType<?> gtuType, LateralDirectionality lateralDirection)

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

getBeginWidth, getBounds, getCenterLine, getContour, getDesignLineOffsetAtBegin, getDesignLineOffsetAtEnd, getEndWidth, getLateralBoundaryPosition, getLateralBoundaryPosition, getLateralCenterPosition, getLateralCenterPosition, getLength, getLocation, getParentLink, getWidth, getWidth, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RoadMarkerAlong

public RoadMarkerAlong(CrossSectionLink<LINKID,NODEID> parentLink,
                       DoubleScalar.Rel<LengthUnit> lateralCenterPosition,
                       DoubleScalar.Rel<LengthUnit> beginWidth,
                       DoubleScalar.Rel<LengthUnit> endWidth)
                throws OTSGeometryException

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.

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

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

Throws:

OTSGeometryException - when creation of the center line or contour geometry fails

Method Detail

getZ

protected final double getZ()

Specified by:

getZ in class CrossSectionElement<LINKID,NODEID>

Returns:

the z-offset for drawing (what's on top, what's underneath).

addPermeability

public final void addPermeability(GTUType<?> gtuType,
                                  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(GTUType<?> gtuType,
                                 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.