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

Interface DirectionalOccupancySensor

All Superinterfaces:

Identifiable, Serializable

public interface DirectionalOccupancySensor
extends 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 Summary

Fields

Modifier and Type	Field	Description
static nl.tudelft.simulation.event.EventType	DIRECTIONAL_OCCUPANCY_SENSOR_TRIGGER_ENTRY_EVENT	The timed event type for pub/sub indicating the triggering of the entry of an OccupancySensor.
static nl.tudelft.simulation.event.EventType	DIRECTIONAL_OCCUPANCY_SENSOR_TRIGGER_EXIT_EVENT	The timed event type for pub/sub indicating the triggering of the exit of an OccupancySensor.

Method Summary

Modifier and Type	Method	Description
String	getId()
LaneBasedObject	getLanePositionEntry()	Return the entry position of this DirectionalOccupancySensor.
LaneBasedObject	getLanePositionExit()	Return the exit position of this DirectionalOccupancySensor.
RelativePosition.TYPE	getPositionTypeEntry()
RelativePosition.TYPE	getPositionTypeExit()
DEVSSimulatorInterface.TimeDoubleUnit	getSimulator()

Field Details

DIRECTIONAL_OCCUPANCY_SENSOR_TRIGGER_ENTRY_EVENT

static final nl.tudelft.simulation.event.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 nl.tudelft.simulation.event.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 Details

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

String getId()

Specified by:

getId in interface Identifiable

Returns:

The id of the sensor.

getSimulator

DEVSSimulatorInterface.TimeDoubleUnit getSimulator()

Returns:

The simulator.