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

Interface SingleSensor

All Superinterfaces:

Comparable<SingleSensor>, nl.tudelft.simulation.event.EventProducerInterface, org.opentrafficsim.base.Identifyable, LaneBasedObject, Locatable, org.opentrafficsim.core.object.ObjectInterface, Sensor, Serializable

All Known Implementing Classes:

AbstractSensor, FlankSensor, FundamentalDiagram.FundamentalDiagramSensor, SimpleReportingSensor, SinkSensor

public interface SingleSensor
extends Sensor, Comparable<SingleSensor>, LaneBasedObject

A sensor is a lane-based object that can be triggered by a relative position of the GTU (e.g., front, back) when that relative position passes over the sensor location on the lane.

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

Field Summary

Fields

Modifier and Type	Field and Description
static org.djunits.value.vdouble.scalar.Length	DEFAULT_SENSOR_ELEVATION Default elevation of a sensor; if the lane is not at elevation 0; this value is probably far off.
static nl.tudelft.simulation.event.EventType	SENSOR_TRIGGER_EVENT The timed event type for pub/sub indicating the triggering of a Sensor on a lane.

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

FIRST_POSITION, LAST_POSITION

Method Summary

Modifier and Type	Method and Description
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.
void	trigger(LaneBasedGTU gtu) Trigger an action on the GTU.

Methods inherited from interface java.lang.Comparable

compareTo

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

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

SENSOR_TRIGGER_EVENT

static final nl.tudelft.simulation.event.EventType SENSOR_TRIGGER_EVENT

The timed event type for pub/sub indicating the triggering of a Sensor on a lane.
Payload: Object[] {String sensorId, Sensor sensor, LaneBasedGTU gtu, RelativePosition.TYPE relativePosition}

DEFAULT_SENSOR_ELEVATION

static final org.djunits.value.vdouble.scalar.Length DEFAULT_SENSOR_ELEVATION

Default elevation of a sensor; if the lane is not at elevation 0; this value is probably far off.

Method Detail

getPositionType

org.opentrafficsim.core.gtu.RelativePosition.TYPE getPositionType()

Returns:

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

trigger

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);.

Parameters:

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

getSimulator

org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface getSimulator()

Returns:

The simulator.

getTriggeringGTUTypes

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

Return which GTU types will trigger this particular sensor.

Returns:

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