Package org.opentrafficsim.road.network.object.detector

Class SinkDetector

java.lang.Object

org.djutils.event.LocalEventProducer

org.opentrafficsim.core.object.StaticObject

org.opentrafficsim.road.network.object.AbstractLaneBasedObject

org.opentrafficsim.road.network.object.detector.LaneDetector

org.opentrafficsim.road.network.object.detector.SinkDetector

All Implemented Interfaces:

Comparable<LaneDetector>, nl.tudelft.simulation.dsol.animation.Locatable, Identifiable, EventProducer, OtsShape, HierarchicallyTyped<DetectorType,Detector>, Detector, LocatedObject, LaneBasedObject

public class SinkDetector
extends LaneDetector

A SinkDetector is a detector that deletes GTUs that hit it, if they comply to a predicate.

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

Field Summary

Fields

Modifier and Type	Field	Description
static final BiPredicate<SinkDetector,LaneBasedGtu>	DESTINATION	Predicate to use to destroy all GTUs with routes ending in the end node of this link, possibly via a connector.

Fields inherited from class org.opentrafficsim.road.network.object.detector.LaneDetector

DEFAULT_DETECTOR_ELEVATION, DETECTOR_TRIGGER_EVENT

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
SinkDetector(Lane lane, org.djunits.value.vdouble.scalar.Length position, DetectorType detectorType)	Constructor.
SinkDetector(Lane lane, org.djunits.value.vdouble.scalar.Length position, DetectorType detectorType, BiPredicate<SinkDetector,LaneBasedGtu> predicate)	Constructor.

Method Summary

Modifier and Type	Method	Description
final String	toString()
final void	triggerResponse(LaneBasedGtu gtu)	Implementation of the response to a trigger of this detector by a GTU.
boolean	willDestroy(LaneBasedGtu gtu)	Returns whether the GTU will be removed by this sink.

Methods inherited from class org.opentrafficsim.road.network.object.detector.LaneDetector

compareTo, equals, getPositionType, getType, hashCode, isCompatible, trigger

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

getFullId, getLane, getLine, getLongitudinalPosition, init

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, finalize, getClass, 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.opentrafficsim.base.HierarchicallyTyped

isOfType

Methods inherited from interface org.djutils.base.Identifiable

getId

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

getLane, getLength, getLine, getLocation, getLongitudinalPosition, getSimulator

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

getZ

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

getFullId, getHeight

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

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

Field Details

DESTINATION

public static final BiPredicate<SinkDetector,LaneBasedGtu> DESTINATION

Predicate to use to destroy all GTUs with routes ending in the end node of this link, possibly via a connector.

Constructor Details

SinkDetector

public SinkDetector(Lane lane,
 org.djunits.value.vdouble.scalar.Length position,
 DetectorType detectorType)
             throws NetworkException

Constructor. All GTUs matching the DetectorType will be removed.

Parameters:

lane - the lane that triggers the deletion of the GTU.

position - the position of the detector

detectorType - detector type.

Throws:

NetworkException - when the position on the lane is out of bounds w.r.t. the center line of the lane

SinkDetector

public SinkDetector(Lane lane,
 org.djunits.value.vdouble.scalar.Length position,
 DetectorType detectorType,
 BiPredicate<SinkDetector,LaneBasedGtu> predicate)
             throws NetworkException

Constructor.

Parameters:

lane - the lane that triggers the deletion of the GTU.

position - the position of the detector

detectorType - detector type.

predicate - predicate for what GTUs will be destroyed.

Throws:

NetworkException - when the position on the lane is out of bounds w.r.t. the center line of the lane

Method Details

triggerResponse

public final void triggerResponse(LaneBasedGtu gtu)

Description copied from class: LaneDetector

Implementation of the response to a trigger of this detector by a GTU.

Specified by:

triggerResponse in class LaneDetector

Parameters:

gtu - the lane based GTU that triggered this detector.

willDestroy

public boolean willDestroy(LaneBasedGtu gtu)

Returns whether the GTU will be removed by this sink.

Parameters:

gtu - gtu.

Returns:

whether the GTU will be removed by this sink.

toString

public final String toString()

Overrides:

toString in class LaneDetector