org.opentrafficsim.road.network.lane

Class Shoulder

java.lang.Object

nl.tudelft.simulation.event.EventProducer

org.opentrafficsim.road.network.lane.CrossSectionElement

org.opentrafficsim.road.network.lane.Shoulder

All Implemented Interfaces:

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

public class Shoulder
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 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

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
protected	Shoulder(CrossSectionLink newParentLink, org.opentrafficsim.core.dsol.OTSSimulatorInterface newSimulator, boolean animation, Shoulder cse) Clone a Shoulder for a new network.
	Shoulder(CrossSectionLink parentLink, String id, org.djunits.value.vdouble.scalar.Length lateralPosition, org.djunits.value.vdouble.scalar.Length width)
	Shoulder(CrossSectionLink parentLink, String id, org.djunits.value.vdouble.scalar.Length lateralPositionStart, org.djunits.value.vdouble.scalar.Length lateralPositionEnd, org.djunits.value.vdouble.scalar.Length beginWidth, org.djunits.value.vdouble.scalar.Length endWidth)
	Shoulder(CrossSectionLink parentLink, String id, List<CrossSectionSlice> crossSectionSlices)

Method Summary

Modifier and Type	Method and Description
Shoulder	clone(CrossSectionLink newParentLink, org.opentrafficsim.core.dsol.OTSSimulatorInterface newSimulator, boolean animation) Clone the CrossSectionElement for e.g., copying a network.
protected double	getZ() Retrieve the Z offset (used to determine what covers what when drawing).
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 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

Shoulder

public Shoulder(CrossSectionLink parentLink,
                String id,
                org.djunits.value.vdouble.scalar.Length lateralPositionStart,
                org.djunits.value.vdouble.scalar.Length lateralPositionEnd,
                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

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 lateralPosition,
                org.djunits.value.vdouble.scalar.Length 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 = 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

Shoulder

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

Clone a Shoulder for a new network.

Parameters:

newParentLink - 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).

toString

public String toString()

Overrides:

toString in class CrossSectionElement

clone

public Shoulder clone(CrossSectionLink newParentLink,
                      org.opentrafficsim.core.dsol.OTSSimulatorInterface newSimulator,
                      boolean animation)
               throws org.opentrafficsim.core.network.NetworkException

Clone the CrossSectionElement for e.g., copying a network.

Specified by:

clone in class CrossSectionElement

Parameters:

newParentLink - the new link to which the clone belongs

newSimulator - the new simulator for this network

animation - whether to (re)create animation or not

Returns:

a clone of this object

Throws:

org.opentrafficsim.core.network.NetworkException - in case the cloning fails