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>, Locatable, nl.tudelft.simulation.event.EventProducerInterface, org.opentrafficsim.base.Identifyable, org.opentrafficsim.core.object.ObjectInterface, LaneBasedObject, Sensor, SingleSensor

Direct Known Subclasses:

FlankSensor, FundamentalDiagram.FundamentalDiagramSensor, SimpleReportingSensor, SinkSensor

public abstract class AbstractSensor
extends AbstractLaneBasedObject
implements SingleSensor

Copyright (c) 2013-2016 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

Modifier and Type	Field and Description
protected static ImmutableSet<org.opentrafficsim.core.gtu.GTUType>	GTUTYPE_SET_ALL The immutable set for all gtu type.

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

Constructor Summary

Constructors

Constructor and Description
AbstractSensor(String id, Lane lane, org.djunits.value.vdouble.scalar.Length longitudinalPosition, org.opentrafficsim.core.gtu.RelativePosition.TYPE positionType, org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator)
AbstractSensor(String id, Lane lane, org.djunits.value.vdouble.scalar.Length longitudinalPosition, org.opentrafficsim.core.gtu.RelativePosition.TYPE positionType, org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator, org.opentrafficsim.core.geometry.OTSLine3D geometry) Create a sensor on a lane at a position on that lane at specified elevation and triggering an all GTU types.
AbstractSensor(String id, Lane lane, org.djunits.value.vdouble.scalar.Length longitudinalPosition, org.opentrafficsim.core.gtu.RelativePosition.TYPE positionType, org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator, org.opentrafficsim.core.geometry.OTSLine3D geometry, ImmutableSet<org.opentrafficsim.core.gtu.GTUType> triggeringGTUTypes) Create a sensor on a lane at a position on that lane at elevation Sensor.DEFAULT_SENSOR_ELEVATION.
AbstractSensor(String id, Lane lane, org.djunits.value.vdouble.scalar.Length longitudinalPosition, org.opentrafficsim.core.gtu.RelativePosition.TYPE positionType, org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator, org.opentrafficsim.core.geometry.OTSLine3D geometry, org.djunits.value.vdouble.scalar.Length elevation) Create a sensor on a lane at a position on that lane at specified elevation and triggering an all GTU types.
AbstractSensor(String id, Lane lane, org.djunits.value.vdouble.scalar.Length longitudinalPosition, org.opentrafficsim.core.gtu.RelativePosition.TYPE positionType, org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator, org.opentrafficsim.core.geometry.OTSLine3D geometry, org.djunits.value.vdouble.scalar.Length elevation, ImmutableSet<org.opentrafficsim.core.gtu.GTUType> triggeringGTUTypes) 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, org.opentrafficsim.core.dsol.OTSSimulatorInterface newSimulator, boolean animation) Clone the LaneBasedObject for e.g., copying a network.
int	compareTo(SingleSensor o)
boolean	equals(Object obj)
org.opentrafficsim.core.gtu.RelativePosition.TYPE	getPositionType()
org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface	getSimulator()
ImmutableSet<org.opentrafficsim.core.gtu.GTUType>	getTriggeringGTUTypes() Return which GTU types will trigger this particular sensor.
int	hashCode()
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, getLane, getLocation, getLongitudinalPosition

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

getBounds, getGeometry, getHeight, getId, toString

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

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

getGeometry, getHeight

Methods inherited from interface org.opentrafficsim.base.Identifyable

getId

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

addListener, addListener, addListener, addListener, removeListener

Field Detail

GTUTYPE_SET_ALL

protected static final ImmutableSet<org.opentrafficsim.core.gtu.GTUType> GTUTYPE_SET_ALL

The immutable set for all gtu type. Implements OTS-219.

Constructor Detail

AbstractSensor

public AbstractSensor(String id,
                      Lane lane,
                      org.djunits.value.vdouble.scalar.Length longitudinalPosition,
                      org.opentrafficsim.core.gtu.RelativePosition.TYPE positionType,
                      org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator,
                      org.opentrafficsim.core.geometry.OTSLine3D geometry,
                      org.djunits.value.vdouble.scalar.Length elevation,
                      ImmutableSet<org.opentrafficsim.core.gtu.GTUType> triggeringGTUTypes)
               throws org.opentrafficsim.core.network.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 - OTSDEVSSimulatorInterface; 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

triggeringGTUTypes - ImmutableSet<GTUType>; The GTU types will trigger this particular sensor

Throws:

org.opentrafficsim.core.network.NetworkException - when the position on the lane is out of bounds

AbstractSensor

public AbstractSensor(String id,
                      Lane lane,
                      org.djunits.value.vdouble.scalar.Length longitudinalPosition,
                      org.opentrafficsim.core.gtu.RelativePosition.TYPE positionType,
                      org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator,
                      org.opentrafficsim.core.geometry.OTSLine3D geometry,
                      ImmutableSet<org.opentrafficsim.core.gtu.GTUType> triggeringGTUTypes)
               throws org.opentrafficsim.core.network.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 - OTSDEVSSimulatorInterface; the simulator (needed to generate the animation).

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

triggeringGTUTypes - ImmutableSet<GTUType>; The GTU types will trigger this particular sensor

Throws:

org.opentrafficsim.core.network.NetworkException - when the position on the lane is out of bounds

AbstractSensor

public AbstractSensor(String id,
                      Lane lane,
                      org.djunits.value.vdouble.scalar.Length longitudinalPosition,
                      org.opentrafficsim.core.gtu.RelativePosition.TYPE positionType,
                      org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator,
                      org.opentrafficsim.core.geometry.OTSLine3D geometry,
                      org.djunits.value.vdouble.scalar.Length elevation)
               throws org.opentrafficsim.core.network.NetworkException

Create a sensor on a lane at a position on that lane at specified elevation and triggering an all GTU types.

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 - OTSDEVSSimulatorInterface; 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

Throws:

org.opentrafficsim.core.network.NetworkException - when the position on the lane is out of bounds

AbstractSensor

public AbstractSensor(String id,
                      Lane lane,
                      org.djunits.value.vdouble.scalar.Length longitudinalPosition,
                      org.opentrafficsim.core.gtu.RelativePosition.TYPE positionType,
                      org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator,
                      org.opentrafficsim.core.geometry.OTSLine3D geometry)
               throws org.opentrafficsim.core.network.NetworkException

Create a sensor on a lane at a position on that lane at specified elevation and triggering an all GTU types.

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 - OTSDEVSSimulatorInterface; the simulator (needed to generate the animation).

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

Throws:

org.opentrafficsim.core.network.NetworkException - when the position on the lane is out of bounds

AbstractSensor

public AbstractSensor(String id,
                      Lane lane,
                      org.djunits.value.vdouble.scalar.Length longitudinalPosition,
                      org.opentrafficsim.core.gtu.RelativePosition.TYPE positionType,
                      org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator)
               throws org.opentrafficsim.core.network.NetworkException

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 - OTSDEVSSimulatorInterface; the simulator (needed to generate the animation).

Throws:

org.opentrafficsim.core.network.NetworkException - when the position on the lane is out of bounds

Method Detail

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 - 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 org.opentrafficsim.core.gtu.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 org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface getSimulator()

Specified by:

getSimulator in interface SingleSensor

Returns:

The simulator.

getTriggeringGTUTypes

public final ImmutableSet<org.opentrafficsim.core.gtu.GTUType> getTriggeringGTUTypes()

Return which GTU types will trigger this particular sensor.

Specified by:

getTriggeringGTUTypes in interface SingleSensor

Returns:

Set<GTUType> the GTU types will trigger this particular sensor.

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>

clone

public abstract AbstractSensor clone(CrossSectionElement newCSE,
                                     org.opentrafficsim.core.dsol.OTSSimulatorInterface 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 - OTSSimulatorInterface; 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