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

Class SinkSensor

java.lang.Object

org.djutils.event.EventProducer

org.opentrafficsim.core.object.StaticObject

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

org.opentrafficsim.road.network.lane.object.sensor.AbstractSensor

org.opentrafficsim.road.network.lane.object.sensor.SinkSensor

All Implemented Interfaces:

Serializable, Comparable<SingleSensor>, Locatable, EventProducerInterface, org.opentrafficsim.base.Identifiable, Drawable, Compatible, ObjectInterface, LaneBasedObject, Sensor, SingleSensor

public class SinkSensor
extends AbstractSensor

A SinkSensor is a sensor that deletes every GTU that hits it.

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

$LastChangedDate: 2015-08-12 16:37:45 +0200 (Wed, 12 Aug 2015) $, @version $Revision: 1240 $, by $Author: averbraeck $, initial version an 30, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields inherited from class org.djutils.event.EventProducer

eventProducerImpl

Fields inherited from interface org.opentrafficsim.core.compatibility.Compatible

EVERYTHING, MINUS, PLUS

Fields inherited from interface org.djutils.event.EventProducerInterface

FIRST_POSITION, LAST_POSITION

Fields inherited from interface org.opentrafficsim.road.network.lane.object.sensor.SingleSensor

DEFAULT_SENSOR_ELEVATION, SENSOR_TRIGGER_EVENT

Constructor Summary

Constructors

Constructor	Description
SinkSensor(Lane lane, Length position, Compatible compatible, OTSSimulatorInterface simulator)
SinkSensor(Lane lane, Length position, GTUDirectionality gtuDirectionality, OTSSimulatorInterface simulator)

Method Summary

Modifier and Type	Method	Description
SinkSensor	clone(CrossSectionElement newCSE, OTSSimulatorInterface newSimulator)	Clone the LaneBasedObject for e.g., copying a network.
String	toString()
void	triggerResponse(LaneBasedGTU gtu)	Implementation of the response to a trigger of this sensor by a GTU.

Methods inherited from class org.opentrafficsim.road.network.lane.object.sensor.AbstractSensor

compareTo, equals, getDetectedGTUTypes, getPositionType, getSimulator, hashCode, isCompatible, makeGeometry, trigger

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

clone, getDirection, getFullId, getLane, getLocation, getLongitudinalPosition, init

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

create, create, getBounds, getGeometry, getHeight, getId, getSourceId

Methods inherited from class org.djutils.event.EventProducer

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.djutils.event.EventProducerInterface

addListener, addListener, addListener, addListener, getEventTypesWithListeners, getSourceId, hasListeners, numberOfListeners, removeListener

Methods inherited from interface org.opentrafficsim.base.Identifiable

getId

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

getBounds, getDirection, getLane, getLocation, getLongitudinalPosition

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

getDirZ, getZ

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

getFullId, getGeometry, getHeight

Constructor Detail

SinkSensor

public SinkSensor(Lane lane,
                  Length position,
                  GTUDirectionality gtuDirectionality,
                  OTSSimulatorInterface simulator)
           throws NetworkException

Parameters:

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

position - Length; the position of the sensor

gtuDirectionality - GTUDirectionality; GTU directionality

simulator - OTSSimulatorInterface; the simulator to enable animation.

Throws:

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

SinkSensor

public SinkSensor(Lane lane,
                  Length position,
                  Compatible compatible,
                  OTSSimulatorInterface simulator)
           throws NetworkException

Parameters:

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

position - Length; the position of the sensor

compatible - Compatible; compatible GTU type and direction

simulator - OTSSimulatorInterface; the simulator to enable animation.

Throws:

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

Method Detail

triggerResponse

public final void triggerResponse(LaneBasedGTU gtu)

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

Specified by:

triggerResponse in class AbstractSensor

Parameters:

gtu - LaneBasedGTU; the lane based GTU that triggered this sensor.

toString

public final String toString()

Overrides:

toString in class AbstractSensor

clone

public SinkSensor clone(CrossSectionElement newCSE,
                        OTSSimulatorInterface newSimulator)
                 throws NetworkException

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

Specified by:

clone in class AbstractSensor

Parameters:

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

newSimulator - OTSSimulatorInterface; the new simulator for this network

Returns:

AbstractLaneBasedObject; a clone of this object

Throws:

NetworkException - in case the cloning fails