org.opentrafficsim.core.network.lane

Interface Sensor

All Superinterfaces:

Comparable<Sensor>, Serializable

All Known Implementing Classes:

AbstractSensor, SensorLaneEnd, SensorLaneStart

public interface Sensor
extends Serializable, Comparable<Sensor>

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

Version:

Dec 31, 2014

Author:

Alexander Verbraeck, Peter Knoppers

Method Summary

Methods

Modifier and Type	Method and Description
Lane	getLane()
DoubleScalar.Abs<LengthUnit>	getLongitudinalPosition()
double	getLongitudinalPositionSI()
RelativePosition.TYPE	getPositionType()
void	trigger(LaneBasedGTU<?> gtu) Trigger an action on the GTU.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getLane

Lane getLane()

Returns:

The lane for which this is a sensor.

getLongitudinalPosition

DoubleScalar.Abs<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