org.opentrafficsim.core.network.lane

Interface Sensor

All Superinterfaces:

Comparable<Sensor>, LocatableInterface, Serializable

All Known Implementing Classes:

AbstractSensor, SinkSensor

public interface Sensor
extends Serializable, Comparable<Sensor>, LocatableInterface

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

$LastChangedDate: 2015-08-30 00:16:51 +0200 (Sun, 30 Aug 2015) $, @version $Revision: 1329 $, by $Author: averbraeck $, initial version Dec 31, 2014

Author:

Alexander Verbraeck, Peter Knoppers

Method Summary

Modifier and Type	Method and Description
Lane	getLane()
org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	getLongitudinalPosition()
double	getLongitudinalPositionSI()
String	getName()
RelativePosition.TYPE	getPositionType()
void	trigger(LaneBasedGTU gtu) Trigger an action on the GTU.

Methods inherited from interface java.lang.Comparable

compareTo

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

getBounds, getLocation

Method Detail

getLane

Lane getLane()

Returns:

The lane for which this is a sensor.

getLongitudinalPosition

org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit> getLongitudinalPosition()

Returns:

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

getLongitudinalPositionSI

double getLongitudinalPositionSI()

Returns:

the position as a double in SI units for quick sorting and sensor triggering.

getPositionType

RelativePosition.TYPE getPositionType()

Returns:

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

trigger

void trigger(LaneBasedGTU gtu)
      throws RemoteException

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.

Throws:

RemoteException - on communications failure

getName

String getName()

Returns:

The name of the sensor.