org.opentrafficsim.core.network.lane

Class CrossSectionElement

java.lang.Object

org.opentrafficsim.core.network.lane.CrossSectionElement

All Implemented Interfaces:

Serializable, LocatableInterface

Direct Known Subclasses:

Lane, RoadMarkerAlong, Shoulder

public abstract class CrossSectionElement
extends Object
implements LocatableInterface, Serializable

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-08-30 13:16:27 +0200 (Sun, 30 Aug 2015) $, @version $Revision: 1344 $, 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 org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	beginWidth Start width, positioned symmetrically around the lateral start position.
protected org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	designLineOffsetAtBegin The lateral offset from the design line of the parentLink at the start of the parentLink.
protected org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	designLineOffsetAtEnd The lateral offset from the design line of the parentLink at the end of the parentLink.
protected org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	endWidth End width, positioned symmetrically around the lateral end position.
protected org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	length The length of the line.
protected CrossSectionLink	parentLink Cross Section Link to which the element belongs.

Constructor Summary

Constructors

Constructor and Description

CrossSectionElement(CrossSectionLink parentLink, String id, org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> lateralOffsetAtBegin, org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> lateralOffsetAtEnd, org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> beginWidth, org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.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
boolean	equals(Object obj)
org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	getBeginWidth()
Bounds	getBounds()
OTSLine3D	getCenterLine()
OTSLine3D	getContour()
org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	getDesignLineOffsetAtBegin()
org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	getDesignLineOffsetAtEnd()
org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	getEndWidth()
String	getId()
org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	getLateralBoundaryPosition(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.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	getLateralBoundaryPosition(LateralDirectionality lateralDirection, org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> 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.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	getLateralCenterPosition(double fractionalPosition) Retrieve the lateral offset from the Link design line at the specified longitudinal position.
org.djunits.value.vdouble.scalar.DoubleScalar<org.djunits.unit.LengthUnit>	getLateralCenterPosition(org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> longitudinalPosition) Retrieve the lateral offset from the Link design line at the specified longitudinal position.
org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	getLength() Return the length of this CrossSectionElement as measured along the design line (which equals the center line).
DirectedPoint	getLocation()
CrossSectionLink	getParentLink()
org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	getWidth(double fractionalPosition) Return the width of this CrossSectionElement at a specified fractional longitudinal position.
org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	getWidth(org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> longitudinalPosition) Return the width of this CrossSectionElement at a specified longitudinal position.
protected abstract double	getZ()
int	hashCode()
String	toString()

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.

designLineOffsetAtBegin

protected final org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> designLineOffsetAtBegin

The lateral offset from the design line of the parentLink at the start of the parentLink.

designLineOffsetAtEnd

protected final org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> designLineOffsetAtEnd

The lateral offset from the design line of the parentLink at the end of the parentLink.

beginWidth

protected final org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> beginWidth

Start width, positioned symmetrically around the lateral start position.

endWidth

protected final org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> endWidth

End width, positioned symmetrically around the lateral end position.

length

protected final org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> length

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

Constructor Detail

CrossSectionElement

public CrossSectionElement(CrossSectionLink parentLink,
                           String id,
                           org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> lateralOffsetAtBegin,
                           org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> lateralOffsetAtEnd,
                           org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> beginWidth,
                           org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> endWidth)
                    throws OTSGeometryException,
                           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 - DoubleScalar.Rel<LengthUnit>; 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 - DoubleScalar.Rel<LengthUnit>; 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 - DoubleScalar.Rel<LengthUnit>; width at start, positioned symmetrically around the design line

endWidth - DoubleScalar.Rel<LengthUnit>; width at end, positioned symmetrically around the design line

Throws:

OTSGeometryException - when creation of the geometry fails

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.DoubleScalar.Rel<org.djunits.unit.LengthUnit> 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:

DoubleScalar.Rel<LengthUnit> the lateralCenterPosition at the specified longitudinal position

getLateralCenterPosition

public final org.djunits.value.vdouble.scalar.DoubleScalar<org.djunits.unit.LengthUnit> getLateralCenterPosition(org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> longitudinalPosition)

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

Parameters:

longitudinalPosition - DoubleScalar.Rel<LengthUnit>; the longitudinal position on this Lane

Returns:

DoubleScalar.Rel<LengthUnit> the lateralCenterPosition at the specified longitudinal position

getWidth

public final org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> getWidth(org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> longitudinalPosition)

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

Parameters:

longitudinalPosition - DoubleScalar<LengthUnit>; the longitudinal position

Returns:

DoubleScalar.Rel<LengthUnit>; the width of this CrossSectionElement at the specified longitudinal position.

getWidth

public final org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> getWidth(double fractionalPosition)

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

Parameters:

fractionalPosition - double; the fractional longitudinal position

Returns:

DoubleScalar.Rel<LengthUnit>; the width of this CrossSectionElement at the specified fractional longitudinal position.

getLength

public final org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> getLength()

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

Returns:

DoubleScalar.Rel<LengthUnit>; the length of this CrossSectionElement

getDesignLineOffsetAtBegin

public final org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> getDesignLineOffsetAtBegin()

Returns:

designLineOffsetAtBegin.

getDesignLineOffsetAtEnd

public final org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> getDesignLineOffsetAtEnd()

Returns:

designLineOffsetAtEnd.

getBeginWidth

public final org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> getBeginWidth()

Returns:

beginWidth.

getEndWidth

public final org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> getEndWidth()

Returns:

endWidth.

getZ

protected abstract double getZ()

Returns:

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

getCenterLine

public final OTSLine3D getCenterLine()

Returns:

centerLine.

getContour

public final OTSLine3D getContour()

Returns:

contour.

getId

public final String getId()

Returns:

id

getLateralBoundaryPosition

public final org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> getLateralBoundaryPosition(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:

DoubleScalar.Rel<LengthUnit>

getLateralBoundaryPosition

public final org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> getLateralBoundaryPosition(LateralDirectionality lateralDirection,
                                                                                                                       org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> 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 - DoubleScalar.Rel<LengthUnit>; the position along the length of this CrossSectionElement

Returns:

DoubleScalar.Rel<LengthUnit>

getLocation

public DirectedPoint getLocation()
                          throws RemoteException

Specified by:

getLocation in interface LocatableInterface

Throws:

RemoteException

getBounds

public Bounds getBounds()
                 throws RemoteException

Specified by:

getBounds in interface LocatableInterface

Throws:

RemoteException

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