org.opentrafficsim.road.network.lane

Class CrossSectionElement

java.lang.Object

nl.tudelft.simulation.event.EventProducer

org.opentrafficsim.road.network.lane.CrossSectionElement

All Implemented Interfaces:

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

Direct Known Subclasses:

Lane, RoadMarkerAlong, Shoulder

public abstract class CrossSectionElement
extends nl.tudelft.simulation.event.EventProducer
implements nl.tudelft.simulation.dsol.animation.Locatable, Serializable

Cross section elements are used to compose a CrossSectionLink.

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-14 01:33:02 +0200 (Mon, 14 Sep 2015) $, @version $Revision: 1401 $, by $Author: averbraeck $, initial version Aug 19, 2014

Author:

Alexander Verbraeck, Peter Knoppers, Guus Tamminga

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<CrossSectionSlice>	crossSectionSlices The offsets and widths at positions along the line, relative to the design line of the parent link.
protected org.djunits.value.vdouble.scalar.Length	length The length of the line.
protected CrossSectionLink	parentLink Cross Section Link to which the element belongs.

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	CrossSectionElement(CrossSectionLink newCrossSectionLink, org.opentrafficsim.core.dsol.OTSSimulatorInterface newSimulator, boolean animation, CrossSectionElement cse) Clone a CrossSectionElement for a new network.
	CrossSectionElement(CrossSectionLink parentLink, String id, org.djunits.value.vdouble.scalar.Length lateralOffset, 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.
	CrossSectionElement(CrossSectionLink parentLink, String id, org.djunits.value.vdouble.scalar.Length lateralOffsetAtBegin, org.djunits.value.vdouble.scalar.Length lateralOffsetAtEnd, 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.
	CrossSectionElement(CrossSectionLink parentLink, String id, 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.

Method Summary

Modifier and Type	Method and Description
abstract CrossSectionElement	clone(CrossSectionLink newParentLink, org.opentrafficsim.core.dsol.OTSSimulatorInterface newSimulator, boolean animation) Clone the CrossSectionElement for e.g., copying a network.
static org.opentrafficsim.core.geometry.OTSShape	constructContour(CrossSectionElement cse) Construct a buffer geometry by offsetting the linear geometry line with a distance and constructing a so-called "buffer" around it.
boolean	equals(Object obj)
org.djunits.value.vdouble.scalar.Length	getBeginWidth() Retrieve the width at the begin of the parent link.
javax.media.j3d.Bounds	getBounds()
org.opentrafficsim.core.geometry.OTSLine3D	getCenterLine() Retrieve the center line of this CrossSectionElement.
org.opentrafficsim.core.geometry.OTSShape	getContour() Retrieve the contour of this CrossSectionElement.
org.djunits.value.vdouble.scalar.Length	getDesignLineOffsetAtBegin() Retrieve the offset from the design line at the begin of the parent link.
org.djunits.value.vdouble.scalar.Length	getDesignLineOffsetAtEnd() Retrieve the offset from the design line at the end of the parent link.
org.djunits.value.vdouble.scalar.Length	getEndWidth() Retrieve the width at the end of the parent link.
String	getId() Retrieve the id of this CrossSectionElement.
org.djunits.value.vdouble.scalar.Length	getLateralBoundaryPosition(org.opentrafficsim.core.network.LateralDirectionality lateralDirection, double fractionalLongitudinalPosition) Return the lateral offset from the design line of the parent Link of the Left or Right boundary of this CrossSectionElement at the specified fractional longitudinal position.
org.djunits.value.vdouble.scalar.Length	getLateralBoundaryPosition(org.opentrafficsim.core.network.LateralDirectionality lateralDirection, org.djunits.value.vdouble.scalar.Length longitudinalPosition) Return the lateral offset from the design line of the parent Link of the Left or Right boundary of this CrossSectionElement at the specified longitudinal position.
org.djunits.value.vdouble.scalar.Length	getLateralCenterPosition(double fractionalPosition) Retrieve the lateral offset from the Link design line at the specified longitudinal position.
org.djunits.value.vdouble.scalar.Length	getLateralCenterPosition(org.djunits.value.vdouble.scalar.Length longitudinalPosition) Retrieve the lateral offset from the Link design line at the specified longitudinal position.
org.djunits.value.vdouble.scalar.Length	getLength() Return the length of this CrossSectionElement as measured along the design line (which equals the center line).
nl.tudelft.simulation.language.d3.DirectedPoint	getLocation()
CrossSectionLink	getParentLink()
org.djunits.value.vdouble.scalar.Length	getWidth(double fractionalPosition) Return the width of this CrossSectionElement at a specified fractional longitudinal position.
org.djunits.value.vdouble.scalar.Length	getWidth(org.djunits.value.vdouble.scalar.Length longitudinalPosition) Return the width of this CrossSectionElement at a specified longitudinal position.
protected abstract double	getZ() Retrieve the Z offset (used to determine what covers what when drawing).
int	hashCode()
String	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

Field Detail

parentLink

protected final CrossSectionLink parentLink

Cross Section Link to which the element belongs.

crossSectionSlices

protected final List<CrossSectionSlice> crossSectionSlices

The offsets and widths at positions along the line, relative to the design line of the parent link.

length

protected final org.djunits.value.vdouble.scalar.Length length

The length of the line. Calculated once at the creation.

Constructor Detail

CrossSectionElement

public CrossSectionElement(CrossSectionLink parentLink,
                           String id,
                           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:

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

parentLink - CrossSectionLink; Link to which the element belongs.

crossSectionSlices - List<CrossSectionSlice>; 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 geometry fails

org.opentrafficsim.core.network.NetworkException - when id equal to null or not unique, or there are multiple slices and the last slice does not end at the length of the design line.

CrossSectionElement

public CrossSectionElement(CrossSectionLink parentLink,
                           String id,
                           org.djunits.value.vdouble.scalar.Length lateralOffsetAtBegin,
                           org.djunits.value.vdouble.scalar.Length lateralOffsetAtEnd,
                           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:

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

parentLink - CrossSectionLink; Link to which the element belongs.

lateralOffsetAtBegin - Length; the lateral offset of the design line of the new CrossSectionLink with respect to the design line of the parent Link at the start of the parent Link

lateralOffsetAtEnd - Length; the lateral offset of the design line of the new CrossSectionLink with respect to the design line of the parent Link at the end of the parent Link

beginWidth - Length; width at start, positioned symmetrically around the design line

endWidth - Length; width at end, positioned symmetrically around the design line

Throws:

org.opentrafficsim.core.geometry.OTSGeometryException - when creation of the geometry fails

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

CrossSectionElement

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

Clone a CrossSectionElement 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.

CrossSectionElement

public CrossSectionElement(CrossSectionLink parentLink,
                           String id,
                           org.djunits.value.vdouble.scalar.Length lateralOffset,
                           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:

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

parentLink - CrossSectionLink; Link to which the element belongs.

lateralOffset - Length; the lateral offset of the design line of the new CrossSectionLink with respect to the design line of the parent Link

width - Length; width, positioned symmetrically around the design line

Throws:

org.opentrafficsim.core.geometry.OTSGeometryException - when creation of the geometry fails

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

Method Detail

getParentLink

public final CrossSectionLink getParentLink()

Returns:

parentLink.

getLateralCenterPosition

public final org.djunits.value.vdouble.scalar.Length getLateralCenterPosition(double fractionalPosition)

Retrieve the lateral offset from the Link design line at the specified longitudinal position.

Parameters:

fractionalPosition - double; fractional longitudinal position on this Lane

Returns:

Length; the lateralCenterPosition at the specified longitudinal position

getLateralCenterPosition

public final org.djunits.value.vdouble.scalar.Length getLateralCenterPosition(org.djunits.value.vdouble.scalar.Length longitudinalPosition)

Retrieve the lateral offset from the Link design line at the specified longitudinal position.

Parameters:

longitudinalPosition - Length; the longitudinal position on this Lane

Returns:

Length; the lateralCenterPosition at the specified longitudinal position

getWidth

public final org.djunits.value.vdouble.scalar.Length getWidth(org.djunits.value.vdouble.scalar.Length longitudinalPosition)

Return the width of this CrossSectionElement at a specified longitudinal position.

Parameters:

longitudinalPosition - DoubleScalar<LengthUnit>; the longitudinal position

Returns:

Length; the width of this CrossSectionElement at the specified longitudinal position.

getWidth

public final org.djunits.value.vdouble.scalar.Length getWidth(double fractionalPosition)

Return the width of this CrossSectionElement at a specified fractional longitudinal position.

Parameters:

fractionalPosition - double; the fractional longitudinal position

Returns:

Length; the width of this CrossSectionElement at the specified fractional longitudinal position.

getLength

public final org.djunits.value.vdouble.scalar.Length getLength()

Return the length of this CrossSectionElement as measured along the design line (which equals the center line).

Returns:

Length; the length of this CrossSectionElement

getDesignLineOffsetAtBegin

public final org.djunits.value.vdouble.scalar.Length getDesignLineOffsetAtBegin()

Retrieve the offset from the design line at the begin of the parent link.

Returns:

Length; the offset of this CrossSectionElement at the begin of the parent link

getDesignLineOffsetAtEnd

public final org.djunits.value.vdouble.scalar.Length getDesignLineOffsetAtEnd()

Retrieve the offset from the design line at the end of the parent link.

Returns:

Length; the offset of this CrossSectionElement at the end of the parent link

getBeginWidth

public final org.djunits.value.vdouble.scalar.Length getBeginWidth()

Retrieve the width at the begin of the parent link.

Returns:

Length; the width of this CrossSectionElement at the begin of the parent link

getEndWidth

public final org.djunits.value.vdouble.scalar.Length getEndWidth()

Retrieve the width at the end of the parent link.

Returns:

Length; the width of this CrossSectionElement at the end of the parent link

getZ

protected abstract double getZ()

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

Returns:

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

getCenterLine

public final org.opentrafficsim.core.geometry.OTSLine3D getCenterLine()

Retrieve the center line of this CrossSectionElement.

Returns:

OTSLine3D; the center line of this CrossSectionElement

getContour

public final org.opentrafficsim.core.geometry.OTSShape getContour()

Retrieve the contour of this CrossSectionElement.

Returns:

OTSShape; the contour of this CrossSectionElement

getId

public final String getId()

Retrieve the id of this CrossSectionElement.

Returns:

String; the id of this CrossSectionElement

getLateralBoundaryPosition

public final org.djunits.value.vdouble.scalar.Length getLateralBoundaryPosition(org.opentrafficsim.core.network.LateralDirectionality lateralDirection,
                                                                                double fractionalLongitudinalPosition)

Return the lateral offset from the design line of the parent Link of the Left or Right boundary of this CrossSectionElement at the specified fractional longitudinal position.

Parameters:

lateralDirection - LateralDirectionality; LEFT, or RIGHT

fractionalLongitudinalPosition - double; ranges from 0.0 (begin of parentLink) to 1.0 (end of parentLink)

Returns:

Length

getLateralBoundaryPosition

public final org.djunits.value.vdouble.scalar.Length getLateralBoundaryPosition(org.opentrafficsim.core.network.LateralDirectionality lateralDirection,
                                                                                org.djunits.value.vdouble.scalar.Length longitudinalPosition)

Return the lateral offset from the design line of the parent Link of the Left or Right boundary of this CrossSectionElement at the specified longitudinal position.

Parameters:

lateralDirection - LateralDirectionality; LEFT, or RIGHT

longitudinalPosition - Length; the position along the length of this CrossSectionElement

Returns:

Length

constructContour

public static org.opentrafficsim.core.geometry.OTSShape constructContour(CrossSectionElement cse)
                                                                  throws org.opentrafficsim.core.geometry.OTSGeometryException,
                                                                         org.opentrafficsim.core.network.NetworkException

Construct a buffer geometry by offsetting the linear geometry line with a distance and constructing a so-called "buffer" around it.

Parameters:

cse - CrossSectionElement; the cross section element to construct the contour for

Returns:

OTSShape; the geometry belonging to this CrossSectionElement.

Throws:

org.opentrafficsim.core.geometry.OTSGeometryException - when construction of the geometry fails

org.opentrafficsim.core.network.NetworkException - when the resulting contour is degenerate (cannot happen; we hope)

getLocation

public nl.tudelft.simulation.language.d3.DirectedPoint getLocation()

Specified by:

getLocation in interface nl.tudelft.simulation.dsol.animation.Locatable

getBounds

public javax.media.j3d.Bounds getBounds()

Specified by:

getBounds in interface nl.tudelft.simulation.dsol.animation.Locatable

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public abstract CrossSectionElement 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.

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