org.opentrafficsim.road.network.lane

Class Stripe

java.lang.Object

nl.tudelft.simulation.event.EventProducer

org.opentrafficsim.road.network.lane.CrossSectionElement

org.opentrafficsim.road.network.lane.RoadMarkerAlong

org.opentrafficsim.road.network.lane.Stripe

All Implemented Interfaces:

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

public class Stripe
extends RoadMarkerAlong

Longitudinal road stripes; simple constructors.

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 Oct 25, 2014

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Stripe.Permeable The types of permeability of a stripe.

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
	Stripe(CrossSectionLink parentLink, org.djunits.value.vdouble.scalar.Length lateralCenterPosition, 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.
	Stripe(CrossSectionLink parentLink, org.djunits.value.vdouble.scalar.Length lateralCenterPosition, org.djunits.value.vdouble.scalar.Length width, Set<org.opentrafficsim.core.gtu.GTUType> gtuTypes, Stripe.Permeable permeable) Helper constructor that immediately provides permeability for a number of GTU classes. 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.
	Stripe(CrossSectionLink parentLink, List<CrossSectionSlice> crossSectionSlices, Stripe.Permeable permeable) Helper constructor that immediately provides permeability for all GTU classes. 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.
protected	Stripe(CrossSectionLink newParentLink, org.opentrafficsim.core.dsol.OTSSimulatorInterface newSimulator, boolean animation, Stripe cse) Clone a Stripe for a new network.

Method Summary

Modifier and Type	Method and Description
void	addPermeability(org.opentrafficsim.core.gtu.GTUType gtuType, Stripe.Permeable permeable)
Stripe	clone(CrossSectionLink newParentLink, org.opentrafficsim.core.dsol.OTSSimulatorInterface newSimulator, boolean animation) Clone the CrossSectionElement for e.g., copying a network.
String	toString()

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

addPermeability, getPermeabilityMap, getZ, isPermeable

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

Stripe

public Stripe(CrossSectionLink parentLink,
              org.djunits.value.vdouble.scalar.Length lateralCenterPosition,
              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:

parentLink - Cross Section Link to which the element belongs

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

width - positioned symmetrically around the center line given by the lateralCenterPosition.

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

Stripe

public Stripe(CrossSectionLink parentLink,
              org.djunits.value.vdouble.scalar.Length lateralCenterPosition,
              org.djunits.value.vdouble.scalar.Length width,
              Set<org.opentrafficsim.core.gtu.GTUType> gtuTypes,
              Stripe.Permeable permeable)
       throws org.opentrafficsim.core.geometry.OTSGeometryException,
              org.opentrafficsim.core.network.NetworkException

Helper constructor that immediately provides permeability for a number of GTU classes.
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:

parentLink - Cross Section Link to which the element belongs

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

width - positioned symmetrically around the center line given by the lateralCenterPosition

gtuTypes - the GTU types for which the permeability is defined

permeable - one of the enums of Stripe.Permeable to define the permeability

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

Stripe

public Stripe(CrossSectionLink parentLink,
              List<CrossSectionSlice> crossSectionSlices,
              Stripe.Permeable permeable)
       throws org.opentrafficsim.core.geometry.OTSGeometryException,
              org.opentrafficsim.core.network.NetworkException

Helper constructor that immediately provides permeability for all GTU classes.
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:

parentLink - Cross Section Link to which the element belongs

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.

permeable - one of the enums of Stripe.Permeable to define the permeability

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

Stripe

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

Clone a Stripe 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

addPermeability

public final void addPermeability(org.opentrafficsim.core.gtu.GTUType gtuType,
                                  Stripe.Permeable permeable)

Parameters:

gtuType - GTU type to add permeability for.

permeable - direction(s) to add compared to the direction of the design line.

toString

public String toString()

Overrides:

toString in class CrossSectionElement

clone

public Stripe 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