LaneBasedObject (OpenTrafficSim road classes 1.6.0 API)

All Superinterfaces:

EventProducerInterface, org.opentrafficsim.base.Identifiable, Locatable, ObjectInterface, Serializable

All Known Subinterfaces:

SingleSensor, TrafficLight

All Known Implementing Classes:

AbstractLaneBasedObject, AbstractSensor, AbstractTrafficLight, BusStop, Conflict, Conflict.ConflictEnd, DestinationSensor, Detector, Distraction, FlankSensor, SimpleReportingSensor, SimpleTrafficLight, SinkSensor, SpeedSign
```
public interface LaneBasedObject
extends ObjectInterface
```
Objects that can be encountered on a Lane like conflict areas, GTUs, traffic lights, stop lines, etc.
Copyright (c) 2013-2022 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.
$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Sep 9, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Field Summary
- Fields inherited from interface org.djutils.event.EventProducerInterface
  FIRST_POSITION, LAST_POSITION

Method Summary

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Bounds`	`getBounds()`	Return the bounds without throwing a RemoteException.
`LongitudinalDirectionality`	`getDirection()`
`Lane`	`getLane()`
`DirectedPoint`	`getLocation()`	Return the location without throwing a RemoteException.
`Length`	`getLongitudinalPosition()`
`static OTSLine3D`	`makeGeometry(Lane lane, Length position)`	Make a geometry perpendicular to the center line of the lane at the given position.

Methods inherited from interface org.djutils.event.EventProducerInterface
addListener, addListener, addListener, addListener, getEventTypesWithListeners, getSourceId, hasListeners, numberOfListeners, removeListener

Methods inherited from interface org.opentrafficsim.base.Identifiable
getId

Methods inherited from interface nl.tudelft.simulation.dsol.animation.Locatable
getDirZ, getZ

Methods inherited from interface org.opentrafficsim.core.object.ObjectInterface
getFullId, getGeometry, getHeight

- Method Detail
  - getLane
```
Lane getLane()
```
    Returns:
    
    The lane for which this is a sensor.
  - getDirection
```
LongitudinalDirectionality getDirection()
```
    Returns:
    
    Longitudinal direction.
  - getLongitudinalPosition
```
Length getLongitudinalPosition()
```
    Returns:
    
    the position (between 0.0 and the length of the Lane) of the sensor on the design line of the lane.
  - getLocation
```
DirectedPoint getLocation()
```
    Return the location without throwing a RemoteException.
    
    Specified by:
    
    getLocation in interface Locatable
    
    Returns:
    
    DirectedPoint; the location
  - getBounds
```
Bounds getBounds()
```
    Return the bounds without throwing a RemoteException.
    
    Specified by:
    
    getBounds in interface Locatable
    
    Specified by:
    
    getBounds in interface ObjectInterface
    
    Returns:
    
    Bounds; the (usually rectangular) bounds of the object
  - makeGeometry
```
static OTSLine3D makeGeometry(Lane lane,
                              Length position)
```
    Make a geometry perpendicular to the center line of the lane at the given position.
    
    Parameters:
    
    lane - Lane; the lane where the sensor resides
    
    position - Length; The length of the object in the longitudinal direction, on the center line of the lane
    
    Returns:
    
    a geometry perpendicular to the center line that describes the sensor