Class Shoulder

java.lang.Object
All Implemented Interfaces:
java.io.Serializable, Locatable, EventProducerInterface, Identifiable, Drawable

public class Shoulder
extends CrossSectionElement

Copyright (c) 2013-2020 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
  • Constructor Details

    • Shoulder

      public Shoulder​(CrossSectionLink parentLink, java.lang.String id, Length lateralPositionStart, Length lateralPositionEnd, Length beginWidth, Length endWidth, boolean fixGradualLateralOffset) throws OTSGeometryException, NetworkException
      Parameters:
      parentLink - CrossSectionLink; Cross Section Link to which the element belongs.
      id - String; the id of the lane. Should be unique within the parentLink.
      lateralPositionStart - Length; the lateral start position compared to the linear geometry of the Cross Section Link.
      lateralPositionEnd - Length; the lateral end position compared to the linear geometry of the Cross Section Link
      beginWidth - Length; start width, positioned <i>symmetrically around</i> the lateral start position.
      endWidth - Length; end width, positioned <i>symmetrically around</i> the lateral end position.
      fixGradualLateralOffset - boolean; true if gradualLateralOffset needs to be fixed
      Throws:
      OTSGeometryException - when creation of the center line or contour geometry fails
      NetworkException - when id equal to null or not unique
    • Shoulder

      public Shoulder​(CrossSectionLink parentLink, java.lang.String id, Length lateralPositionStart, Length lateralPositionEnd, Length beginWidth, Length endWidth) throws OTSGeometryException, NetworkException
      Parameters:
      parentLink - CrossSectionLink; Cross Section Link to which the element belongs.
      id - String; the id of the lane. Should be unique within the parentLink.
      lateralPositionStart - Length; the lateral start position compared to the linear geometry of the Cross Section Link.
      lateralPositionEnd - Length; the lateral end position compared to the linear geometry of the Cross Section Link
      beginWidth - Length; start width, positioned <i>symmetrically around</i> the lateral start position.
      endWidth - Length; end width, positioned <i>symmetrically around</i> the lateral end position.
      Throws:
      OTSGeometryException - when creation of the center line or contour geometry fails
      NetworkException - when id equal to null or not unique
    • Shoulder

      public Shoulder​(CrossSectionLink parentLink, java.lang.String id, Length lateralPosition, Length width) throws OTSGeometryException, NetworkException
      Parameters:
      parentLink - CrossSectionLink; Cross Section Link to which the element belongs.
      id - String; the id of the lane. Should be unique within the parentLink.
      lateralPosition - Length; the lateral start position compared to the linear geometry of the Cross Section Link.
      width - Length; the shoulder width, positioned <i>symmetrically around</i> the lateral start position.
      Throws:
      OTSGeometryException - when creation of the center line or contour geometry fails
      NetworkException - when id equal to null or not unique
    • Shoulder

      public Shoulder​(CrossSectionLink parentLink, java.lang.String id, java.util.List<CrossSectionSlice> crossSectionSlices) throws OTSGeometryException, NetworkException
      Parameters:
      parentLink - CrossSectionLink; Cross Section Link to which the element belongs.
      id - String; the id of the lane. Should be unique within the parentLink.
      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:
      OTSGeometryException - when creation of the center line or contour geometry fails
      NetworkException - when id equal to null or not unique
    • Shoulder

      protected Shoulder​(CrossSectionLink newParentLink, SimulatorInterface.TimeDoubleUnit newSimulator, Shoulder cse) throws NetworkException
      Clone a Shoulder for a new network.
      Parameters:
      newParentLink - CrossSectionLink; the new link to which the clone belongs
      newSimulator - SimulatorInterface.TimeDoubleUnit; the new simulator for this network
      cse - Shoulder; the element to clone from
      Throws:
      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 Details