org.opentrafficsim.road.network.lane

Class Shoulder

java.lang.Object

org.opentrafficsim.road.network.lane.CrossSectionElement

org.opentrafficsim.road.network.lane.Shoulder

All Implemented Interfaces:

Serializable, nl.tudelft.simulation.dsol.animation.LocatableInterface

public class Shoulder
extends CrossSectionElement

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-09-03 13:38:01 +0200 (Thu, 03 Sep 2015) $, @version $Revision: 1378 $, by $Author: averbraeck $, initial version Aug 19, 2014

Author:

Alexander Verbraeck, Peter Knoppers, Guus Tamminga

See Also:

Serialized Form

Field Summary

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

crossSectionSlices, length, parentLink

Constructor Summary

Constructors

Constructor and Description
Shoulder(CrossSectionLink parentLink, String id, org.djunits.value.vdouble.scalar.Length.Rel lateralPosition, org.djunits.value.vdouble.scalar.Length.Rel width)
Shoulder(CrossSectionLink parentLink, String id, org.djunits.value.vdouble.scalar.Length.Rel lateralPositionStart, org.djunits.value.vdouble.scalar.Length.Rel lateralPositionEnd, org.djunits.value.vdouble.scalar.Length.Rel beginWidth, org.djunits.value.vdouble.scalar.Length.Rel endWidth)
Shoulder(CrossSectionLink parentLink, String id, List<CrossSectionSlice> crossSectionSlices)

Method Summary

Modifier and Type	Method and Description
protected double	getZ()
String	toString()

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Shoulder

public Shoulder(CrossSectionLink parentLink,
                String id,
                org.djunits.value.vdouble.scalar.Length.Rel lateralPositionStart,
                org.djunits.value.vdouble.scalar.Length.Rel lateralPositionEnd,
                org.djunits.value.vdouble.scalar.Length.Rel beginWidth,
                org.djunits.value.vdouble.scalar.Length.Rel endWidth)
         throws org.opentrafficsim.core.geometry.OTSGeometryException,
                org.opentrafficsim.core.network.NetworkException

Parameters:

parentLink - Cross Section Link to which the element belongs.

id - String; the id of the lane. Should be unique within the parentLink.

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

lateralPositionEnd - the lateral end 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:

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

Shoulder

public Shoulder(CrossSectionLink parentLink,
                String id,
                org.djunits.value.vdouble.scalar.Length.Rel lateralPosition,
                org.djunits.value.vdouble.scalar.Length.Rel width)
         throws org.opentrafficsim.core.geometry.OTSGeometryException,
                org.opentrafficsim.core.network.NetworkException

Parameters:

parentLink - Cross Section Link to which the element belongs.

id - String; the id of the lane. Should be unique within the parentLink.

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

width - the shoulder 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

Shoulder

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

Parameters:

parentLink - Cross Section Link to which the element belongs.

id - String; the id of the lane. Should be unique within the parentLink.

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.Rel = 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

Method Detail

getZ

protected final double getZ()

Specified by:

getZ in class CrossSectionElement

Returns:

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

toString

public String toString()

Overrides:

toString in class CrossSectionElement