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

Class AbstractSensor

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.sensor.AbstractSensor

All Implemented Interfaces:

Serializable, Comparable<SingleSensor>, nl.tudelft.simulation.dsol.animation.Locatable, nl.tudelft.simulation.event.EventProducerInterface, Identifiable, Drawable, Compatible, ObjectInterface, LaneBasedObject, Sensor, SingleSensor

Direct Known Subclasses:

Detector, FlankSensor, SimpleReportingSensor, SinkSensor

public abstract class AbstractSensor
extends AbstractLaneBasedObject
implements SingleSensor

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

$LastChangedDate: 2015-09-14 01:33:02 +0200 (Mon, 14 Sep 2015) $, @version $Revision: 1401 $, by $Author: averbraeck $, initial version Dec 31, 2014

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields inherited from class nl.tudelft.simulation.event.EventProducer

listeners

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

DEFAULT_SENSOR_ELEVATION, SENSOR_TRIGGER_EVENT

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

FIRST_POSITION, LAST_POSITION

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

EVERYTHING, MINUS, PLUS

Constructor Summary

Constructors

Constructor and Description
AbstractSensor(String id, Lane lane, Length longitudinalPosition, RelativePosition.TYPE positionType, nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDoubleUnit simulator, Compatible detectedGTUTypes) Create a new AbstractSensor on a lane at a position on that lane at elevation Sensor.DEFAULT_SENSOR_ELEVATION and default geometry.
AbstractSensor(String id, Lane lane, Length longitudinalPosition, RelativePosition.TYPE positionType, nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDoubleUnit simulator, OTSLine3D geometry, Compatible detectedGTUTypes) Create a sensor on a lane at a position on that lane at elevation Sensor.DEFAULT_SENSOR_ELEVATION.
AbstractSensor(String id, Lane lane, Length longitudinalPosition, RelativePosition.TYPE positionType, nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDoubleUnit simulator, OTSLine3D geometry, Length elevation, Compatible detectedGTUTypes) Create a sensor on a lane at a position on that lane.

Method Summary

Modifier and Type	Method and Description
abstract AbstractSensor	clone(CrossSectionElement newCSE, nl.tudelft.simulation.dsol.simulators.SimulatorInterface.TimeDoubleUnit newSimulator) Clone the LaneBasedObject for e.g., copying a network.
int	compareTo(SingleSensor o)
boolean	equals(Object obj)
Compatible	getDetectedGTUTypes() Retrieve the object that decides if a particular GTU type is detected when passing in a particular direction.
RelativePosition.TYPE	getPositionType()
nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDoubleUnit	getSimulator()
int	hashCode()
boolean	isCompatible(GTUType gtuType, GTUDirectionality directionality)
protected static OTSLine3D	makeGeometry(Lane lane, Length longitudinalPosition, double relativeWidth) Make a geometry perpendicular to the center line of the lane with a length of 90% of the width of the lane.
String	toString()
void	trigger(LaneBasedGTU gtu) Trigger an action on the GTU.
protected abstract 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.AbstractLaneBasedObject

clone, getDirection, getFullId, getLane, getLocation, getLongitudinalPosition

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

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

getBounds, getDirection, getLane, getLocation, getLongitudinalPosition, makeGeometry

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

getFullId, 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

AbstractSensor

public AbstractSensor(String id,
                      Lane lane,
                      Length longitudinalPosition,
                      RelativePosition.TYPE positionType,
                      nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDoubleUnit simulator,
                      OTSLine3D geometry,
                      Length elevation,
                      Compatible detectedGTUTypes)
               throws NetworkException

Create a sensor on a lane at a position on that lane.

Parameters:

id - String; the id of the sensor.

lane - Lane; the lane for which this is a sensor.

longitudinalPosition - Length; the position (between 0.0 and the length of the Lane) of the sensor on the design line of the lane.

positionType - RelativePosition.TYPE; the relative position type (e.g., FRONT, BACK) of the vehicle that triggers the sensor.

simulator - DEVSSimulatorInterface.TimeDoubleUnit; the simulator (needed to generate the animation).

geometry - OTSLine3D; the geometry of the object, which provides its location and bounds as well

elevation - Length; elevation of the sensor

detectedGTUTypes - Compatible; The GTU types will trigger this sensor

Throws:

NetworkException - when the position on the lane is out of bounds

AbstractSensor

public AbstractSensor(String id,
                      Lane lane,
                      Length longitudinalPosition,
                      RelativePosition.TYPE positionType,
                      nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDoubleUnit simulator,
                      OTSLine3D geometry,
                      Compatible detectedGTUTypes)
               throws NetworkException

Create a sensor on a lane at a position on that lane at elevation Sensor.DEFAULT_SENSOR_ELEVATION.

Parameters:

id - String; the id of the sensor.

lane - Lane; the lane for which this is a sensor.

longitudinalPosition - Length; the position (between 0.0 and the length of the Lane) of the sensor on the design line of the lane.

positionType - RelativePosition.TYPE; the relative position type (e.g., FRONT, BACK) of the vehicle that triggers the sensor.

simulator - DEVSSimulatorInterface.TimeDoubleUnit; the simulator (needed to generate the animation).

geometry - OTSLine3D; the geometry of the object, which provides its location and bounds as well

detectedGTUTypes - Compatible; The GTU types will trigger this sensor

Throws:

NetworkException - when the position on the lane is out of bounds

AbstractSensor

public AbstractSensor(String id,
                      Lane lane,
                      Length longitudinalPosition,
                      RelativePosition.TYPE positionType,
                      nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDoubleUnit simulator,
                      Compatible detectedGTUTypes)
               throws NetworkException

Create a new AbstractSensor on a lane at a position on that lane at elevation Sensor.DEFAULT_SENSOR_ELEVATION and default geometry.

Parameters:

id - String; the id of the new AbstractSensor

lane - Lane; the lane on which the new AbstractSensor is positioned

longitudinalPosition - Length; the position (between 0.0 and the length of the Lane) of the sensor on the design line of the lane

positionType - RelativePosition.TYPE; the relative position type (e.g., FRONT, BACK) of the vehicle that triggers the sensor.

simulator - DEVSSimulatorInterface.TimeDoubleUnit; the simulator (needed to generate the animation).

detectedGTUTypes - Compatible; The GTU types will trigger this sensor

Throws:

NetworkException - when the position on the lane is out of bounds

Method Detail

makeGeometry

protected static OTSLine3D makeGeometry(Lane lane,
                                        Length longitudinalPosition,
                                        double relativeWidth)
                                 throws NetworkException

Make a geometry perpendicular to the center line of the lane with a length of 90% of the width of the lane.

Parameters:

lane - Lane; the lane for which to make a perpendicular geometry

longitudinalPosition - Length; the position on the lane

relativeWidth - double; lane width to use

Returns:

an OTSLine3D that describes the line

Throws:

NetworkException - in case the sensor point on the center line of the lane cannot be found

trigger

public final void trigger(LaneBasedGTU gtu)

Trigger an action on the GTU. Normally this is the GTU that triggered the sensor. The typical call therefore is sensor.trigger(this);.

Specified by:

trigger in interface SingleSensor

Parameters:

gtu - LaneBasedGTU; the GTU for which to carry out the trigger action.

triggerResponse

protected abstract void triggerResponse(LaneBasedGTU gtu)

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

Parameters:

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

getPositionType

public final RelativePosition.TYPE getPositionType()

Specified by:

getPositionType in interface SingleSensor

Returns:

the relative position type of the vehicle (e.g., FRONT, BACK) that triggers the sensor.

getSimulator

public final nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDoubleUnit getSimulator()

Specified by:

getSimulator in interface SingleSensor

Returns:

The simulator.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(SingleSensor o)

Specified by:

compareTo in interface Comparable<SingleSensor>

toString

public String toString()

Overrides:

toString in class AbstractLaneBasedObject

clone

public abstract AbstractSensor clone(CrossSectionElement newCSE,
                                     nl.tudelft.simulation.dsol.simulators.SimulatorInterface.TimeDoubleUnit newSimulator)
                              throws 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

Returns:

AbstractLaneBasedObject; a clone of this object

Throws:

NetworkException - in case the cloning fails

isCompatible

public final boolean isCompatible(GTUType gtuType,
                                  GTUDirectionality directionality)

Specified by:

isCompatible in interface Compatible

getDetectedGTUTypes

public final Compatible getDetectedGTUTypes()

Retrieve the object that decides if a particular GTU type is detected when passing in a particular direction.

Returns:

Compatible; the object that decides if a particular GTU type is detected when passing in a particular direction