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

Interface DirectionalOccupancySensor

  • All Superinterfaces:
    Identifiable, java.io.Serializable
    public interface DirectionalOccupancySensor
extends java.io.Serializable, Identifiable
    An occupancy 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-2020 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 Detail

      • DIRECTIONAL_OCCUPANCY_SENSOR_TRIGGER_ENTRY_EVENT

        static final EventType DIRECTIONAL_OCCUPANCY_SENSOR_TRIGGER_ENTRY_EVENT
        The timed event type for pub/sub indicating the triggering of the entry of an OccupancySensor.
        Payload: Object[] {String sensorId, Sensor sensor, LaneBasedGTU gtu, RelativePosition.TYPE relativePosition}

      • DIRECTIONAL_OCCUPANCY_SENSOR_TRIGGER_EXIT_EVENT

        static final EventType DIRECTIONAL_OCCUPANCY_SENSOR_TRIGGER_EXIT_EVENT
        The timed event type for pub/sub indicating the triggering of the exit of an OccupancySensor.
        Payload: Object[] {String sensorId, Sensor sensor, LaneBasedGTU gtu, RelativePosition.TYPE relativePosition}

    • Method Detail

      • getPositionTypeEntry

        RelativePosition.TYPE getPositionTypeEntry()
        Returns:
        the relative position type of the vehicle (e.g., FRONT, BACK) that triggers the sensor.

      • getPositionTypeExit

        RelativePosition.TYPE getPositionTypeExit()
        Returns:
        the relative position type of the vehicle (e.g., FRONT, BACK) that triggers the sensor.

      • getLanePositionEntry

        LaneBasedObject getLanePositionEntry()
        Return the entry position of this DirectionalOccupancySensor.
        Returns:
        LaneBasedObject; the lane and position on the lane where GTU entry is detected

      • getLanePositionExit

        LaneBasedObject getLanePositionExit()
        Return the exit position of this DirectionalOccupancySensor.
        Returns:
        LaneBasedObject; the lane and position on the lane where GTU exit is detected

      • getId

        java.lang.String getId()
        Specified by:
        getId in interface Identifiable
        Returns:
        The id of the sensor.