Package org.opentrafficsim.road.network.lane.object

Class RoadSideDistraction

java.lang.Object

org.djutils.event.LocalEventProducer

org.opentrafficsim.core.object.StaticObject

org.opentrafficsim.road.network.lane.object.AbstractLaneBasedObject

org.opentrafficsim.road.network.lane.object.RoadSideDistraction

All Implemented Interfaces:

nl.tudelft.simulation.dsol.animation.Locatable, Identifiable, EventProducer, OtsShape, LocatedObject, LaneBasedObject

public class RoadSideDistraction
extends AbstractLaneBasedObject

Distraction following a distance profile.

Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RoadSideDistraction.DistractionProfile	Describes the profile around the distraction.
static class	RoadSideDistraction.TrapezoidProfile	Distraction profile with trapezoid shape.

Field Summary

Fields inherited from interface org.djutils.event.EventProducer

FIRST_POSITION, LAST_POSITION

Fields inherited from interface org.opentrafficsim.base.geometry.OtsShape

DEFAULT_POLYGON_SEGMENTS, WORLD_MARGIN_LINE

Constructor Summary

Constructors

Constructor	Description
RoadSideDistraction(String id, Lane lane, Length longitudinalPosition, RoadSideDistraction.DistractionProfile profile, LateralDirectionality side)	Constructor.

Method Summary

Modifier and Type	Method	Description
OptionalDouble	getDistraction(Length distance)	Returns the level of distraction at the given distance.
LateralDirectionality	getSide()	Returns the side of the distraction, relative to the driving direction.

Methods inherited from class org.opentrafficsim.road.network.lane.object.AbstractLaneBasedObject

getFullId, getLane, getLine, getLongitudinalPosition, init, toString

Methods inherited from class org.opentrafficsim.core.object.StaticObject

create, create, getAbsoluteContour, getHeight, getId, getLocation, getRelativeBounds, getRelativeContour

Methods inherited from class org.djutils.event.LocalEventProducer

getEventListenerMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.djutils.event.EventProducer

addListener, addListener, addListener, addListener, fireEvent, fireEvent, fireEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, getEventListenerMap, getEventTypesWithListeners, getListenerReferences, hasListeners, numberOfListeners, removeAllListeners, removeAllListeners, removeListener

Methods inherited from interface org.djutils.base.Identifiable

getId

Methods inherited from interface org.opentrafficsim.road.network.lane.object.LaneBasedObject

getLength, getLocation, getSimulator

Methods inherited from interface nl.tudelft.simulation.dsol.animation.Locatable

getZ

Methods inherited from interface org.opentrafficsim.core.object.LocatedObject

getHeight

Methods inherited from interface org.opentrafficsim.base.geometry.OtsShape

contains, contains, getAbsoluteBounds, getAbsoluteContour, getAbsoluteContour, getDirZ, getRelativeBounds, getRelativeContour, signedDistance, signedDistance

Constructor Details

RoadSideDistraction

public RoadSideDistraction(String id,
 Lane lane,
 Length longitudinalPosition,
 RoadSideDistraction.DistractionProfile profile,
 LateralDirectionality side)
                    throws NetworkException

Constructor.

Parameters:

id - id

lane - lane

longitudinalPosition - longitudinal position

profile - distraction profile

side - side of the distraction, left of road (LEFT), right of road (RIGHT), or on the lane of the object (NONE)

Throws:

NetworkException - on network exception

Method Details

getDistraction

public OptionalDouble getDistraction(Length distance)

Returns the level of distraction at the given distance.

Parameters:

distance - negative when approaching

Returns:

level of distraction (task-demand), empty if the distraction is no longer important

getSide

public LateralDirectionality getSide()

Returns the side of the distraction, relative to the driving direction.

Returns:

side of the distraction, left of road (LEFT), right of road (RIGHT), or on the lane of the object (NONE)