org.opentrafficsim.road.network.lane.object

Class Distraction

java.lang.Object

nl.tudelft.simulation.event.EventProducer

org.opentrafficsim.core.object.StaticObject

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

org.opentrafficsim.road.network.lane.object.Distraction

All Implemented Interfaces:

Serializable, nl.tudelft.simulation.dsol.animation.Locatable, nl.tudelft.simulation.event.EventProducerInterface, org.opentrafficsim.base.Identifiable, org.opentrafficsim.core.object.ObjectInterface, LaneBasedObject

public class Distraction
extends AbstractLaneBasedObject

Distraction following a distance profile.

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

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version 5 apr. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

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

Constructor and Description
Distraction(String id, Lane lane, org.djunits.value.vdouble.scalar.Length longitudinalPosition, nl.tudelft.simulation.dsol.simulators.SimulatorInterface.TimeDoubleUnit simulator, Distraction.DistractionProfile profile)

Method Summary

Modifier and Type	Method and Description
AbstractLaneBasedObject	clone(CrossSectionElement newCSE, nl.tudelft.simulation.dsol.simulators.SimulatorInterface.TimeDoubleUnit newSimulator, boolean animation) Clone the LaneBasedObject for e.g., copying a network.
Double	getDistraction(org.djunits.value.vdouble.scalar.Length distance) Returns the level of distraction at the given distance.

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

clone, getDirection, getFullId, getLane, getLocation, getLongitudinalPosition, toString

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

getBounds, getGeometry, getHeight, getId

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getBounds, makeGeometry

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

getGeometry, getHeight

Methods inherited from interface org.opentrafficsim.base.Identifiable

getId

Methods inherited from interface nl.tudelft.simulation.event.EventProducerInterface

addListener, addListener, addListener, addListener, removeListener

Constructor Detail

Distraction

public Distraction(String id,
                   Lane lane,
                   org.djunits.value.vdouble.scalar.Length longitudinalPosition,
                   nl.tudelft.simulation.dsol.simulators.SimulatorInterface.TimeDoubleUnit simulator,
                   Distraction.DistractionProfile profile)
            throws org.opentrafficsim.core.network.NetworkException

Parameters:

id - String; id

lane - Lane; lane

longitudinalPosition - Length; longitudinal position

simulator - SimulatorInterface.TimeDoubleUnit; simulator

profile - DistractionProfile; distraction profile

Throws:

org.opentrafficsim.core.network.NetworkException - on network exception

Method Detail

clone

public AbstractLaneBasedObject clone(CrossSectionElement newCSE,
                                     nl.tudelft.simulation.dsol.simulators.SimulatorInterface.TimeDoubleUnit newSimulator,
                                     boolean animation)
                              throws org.opentrafficsim.core.network.NetworkException

Clone the LaneBasedObject for e.g., copying a network.

Specified by:

clone in class AbstractLaneBasedObject

Parameters:

newCSE - CrossSectionElement; the new cross section element to which the clone belongs

newSimulator - SimulatorInterface.TimeDoubleUnit; the new simulator for this network

animation - boolean; whether to (re)create animation or not

Returns:

AbstractLaneBasedObject; a clone of this object

Throws:

org.opentrafficsim.core.network.NetworkException - in case the cloning fails

getDistraction

public Double getDistraction(org.djunits.value.vdouble.scalar.Length distance)

Returns the level of distraction at the given distance.

Parameters:

distance - Distance to distraction; negative when approaching

Returns:

Double; level of distraction (task-demand), or null if the distraction is no longer important