org.opentrafficsim.road.network.lane

Class AbstractSensor

java.lang.Object

org.opentrafficsim.road.network.lane.AbstractSensor

All Implemented Interfaces:

Serializable, Comparable<Sensor>, nl.tudelft.simulation.dsol.animation.LocatableInterface, Sensor

Direct Known Subclasses:

FundamentalDiagram.FundamentalDiagramSensor, SinkSensor

public abstract class AbstractSensor
extends Object
implements Sensor

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-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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractSensor(Lane lane, org.djunits.value.vdouble.scalar.Length.Rel longitudinalPosition, org.opentrafficsim.core.gtu.RelativePosition.TYPE positionType, String name, org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Sensor o)
boolean	equals(Object obj)
javax.media.j3d.Bounds	getBounds()
Lane	getLane()
nl.tudelft.simulation.language.d3.DirectedPoint	getLocation()
org.djunits.value.vdouble.scalar.Length.Rel	getLongitudinalPosition()
double	getLongitudinalPositionSI()
String	getName()
org.opentrafficsim.core.gtu.RelativePosition.TYPE	getPositionType()
org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface	getSimulator()
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opentrafficsim.road.network.lane.Sensor

trigger

Constructor Detail

AbstractSensor

public AbstractSensor(Lane lane,
                      org.djunits.value.vdouble.scalar.Length.Rel longitudinalPosition,
                      org.opentrafficsim.core.gtu.RelativePosition.TYPE positionType,
                      String name,
                      org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator)

Parameters:

lane - The lane for which this is a sensor.

longitudinalPosition - DoubleScalar.Rel<LengthUnit>; the position (between 0.0 and the length of the Lane) of the sensor on the design line of the lane.

positionType - RelativePosition.TYPE; the relative position type (e.g., FRONT, BACK) of the vehicle that triggers the sensor.

name - the name of the sensor.

simulator - the simulator for being able to generate the animation.

Method Detail

getLane

public final Lane getLane()

Specified by:

getLane in interface Sensor

Returns:

The lane for which this is a sensor.

getLongitudinalPosition

public final org.djunits.value.vdouble.scalar.Length.Rel getLongitudinalPosition()

Specified by:

getLongitudinalPosition in interface Sensor

Returns:

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

getPositionType

public final org.opentrafficsim.core.gtu.RelativePosition.TYPE getPositionType()

Specified by:

getPositionType in interface Sensor

Returns:

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

getLongitudinalPositionSI

public final double getLongitudinalPositionSI()

Specified by:

getLongitudinalPositionSI in interface Sensor

Returns:

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

getLocation

public final nl.tudelft.simulation.language.d3.DirectedPoint getLocation()

Specified by:

getLocation in interface nl.tudelft.simulation.dsol.animation.LocatableInterface

Specified by:

getLocation in interface Sensor

getBounds

public final javax.media.j3d.Bounds getBounds()

Specified by:

getBounds in interface nl.tudelft.simulation.dsol.animation.LocatableInterface

Specified by:

getBounds in interface Sensor

getName

public final String getName()

Specified by:

getName in interface Sensor

Returns:

name.

getSimulator

public final org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface getSimulator()

Returns:

simulator

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(Sensor o)

Specified by:

compareTo in interface Comparable<Sensor>