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

Class Detector

java.lang.Object

nl.tudelft.simulation.event.EventProducer

org.opentrafficsim.core.object.StaticObject

org.opentrafficsim.road.network.lane.object.AbstractLaneBasedObject

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

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

All Implemented Interfaces:

Serializable, Comparable<SingleSensor>, nl.tudelft.simulation.dsol.animation.Locatable, nl.tudelft.simulation.event.EventProducerInterface, org.opentrafficsim.base.Identifiable, org.opentrafficsim.core.compatibility.Compatible, org.opentrafficsim.core.object.ObjectInterface, LaneBasedObject, Sensor, SingleSensor

public class Detector
extends AbstractSensor

Detector, measuring a dynamic set of measurements.

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

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version 5 mrt. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Detector.CompressionMethod Defines the compression method for stored data.
static interface	Detector.DetectorMeasurement<C,A> Interface for what detectors measure.
(package private) static class	Detector.PlatoonMeasurement Cumulative information for platoon size measurement.
static class	Detector.PlatoonSizes Measurement of platoon sizes based on time between previous GTU exit and GTU entry.

Field Summary

Fields

Modifier and Type	Field and Description
static nl.tudelft.simulation.event.EventType	DETECTOR_AGGREGATE Aggregation event.
static nl.tudelft.simulation.event.EventType	DETECTOR_TRIGGERED Trigger event.
static Detector.DetectorMeasurement<Double,org.djunits.value.vdouble.scalar.Speed>	HARMONIC_MEAN_SPEED Harmonic mean speed measurement.
static Detector.DetectorMeasurement<Double,org.djunits.value.vdouble.scalar.Speed>	MEAN_SPEED Mean speed measurement.
static Detector.DetectorMeasurement<Double,Double>	OCCUPANCY Occupancy measurement.
static Detector.DetectorMeasurement<List<Double>,List<Double>>	PASSAGES Passages measurement.

Fields inherited from class nl.tudelft.simulation.event.EventProducer

listeners

Fields inherited from interface org.opentrafficsim.road.network.lane.object.sensor.SingleSensor

DEFAULT_SENSOR_ELEVATION, SENSOR_TRIGGER_EVENT

Fields inherited from interface nl.tudelft.simulation.event.EventProducerInterface

FIRST_POSITION, LAST_POSITION

Fields inherited from interface org.opentrafficsim.core.compatibility.Compatible

EVERYTHING

Constructor Summary

Constructors

Constructor and Description
Detector(String id, Lane lane, org.djunits.value.vdouble.scalar.Length longitudinalPosition, org.djunits.value.vdouble.scalar.Length length, org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator, org.djunits.value.vdouble.scalar.Duration aggregation, Detector.DetectorMeasurement<?,?>... measurements) Constructor.
Detector(String id, Lane lane, org.djunits.value.vdouble.scalar.Length longitudinalPosition, org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator) Constructor for regular Dutch dual-loop detectors measuring flow and mean speed aggregated over 60s.

Method Summary

Modifier and Type	Method and Description
(package private) <C> void	accumulate(Detector.DetectorMeasurement<C,?> measurement, LaneBasedGTU gtu, boolean front) Accumulates a measurement.
AbstractSensor	clone(CrossSectionElement newCSE, org.opentrafficsim.core.dsol.OTSSimulatorInterface newSimulator, boolean animation) Clone the LaneBasedObject for e.g., copying a network.
org.djunits.value.vdouble.scalar.Length	getLength() Returns the detector length.
Map<Detector.DetectorMeasurement<?,?>,Object>	getMesoMeasurements() Returns a map of non-periodical measurements.
static String	printListDouble(List<Double> list, String format) Prints a list of doubles in to a formatted string.
static String	removeTrailingZeros(String string) Remove any trailing zeros.
protected void	triggerResponse(LaneBasedGTU gtu) Implementation of the response to a trigger of this sensor by a GTU.
static void	writeToFile(org.opentrafficsim.core.network.OTSNetwork network, String file, boolean periodic) Write the contents of all detectors in to a file.
static <C> void	writeToFile(org.opentrafficsim.core.network.OTSNetwork network, String file, boolean periodic, String format, Detector.CompressionMethod compression) Write the contents of all detectors in to a file.

Methods inherited from class org.opentrafficsim.road.network.lane.object.sensor.AbstractSensor

compareTo, equals, getDetectedGTUTypes, getPositionType, getSimulator, hashCode, isCompatible, toString, trigger

Methods inherited from class org.opentrafficsim.road.network.lane.object.AbstractLaneBasedObject

clone, getDirection, getFullId, getLane, getLocation, getLongitudinalPosition

Methods inherited from class org.opentrafficsim.core.object.StaticObject

getBounds, getGeometry, getHeight, getId

Methods inherited from class nl.tudelft.simulation.event.EventProducer

addListener, addListener, addListener, addListener, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, removeAllListeners, removeAllListeners, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opentrafficsim.road.network.lane.object.LaneBasedObject

getBounds, getDirection, getLane, getLocation, getLongitudinalPosition

Methods inherited from interface org.opentrafficsim.core.object.ObjectInterface

getFullId, getGeometry, getHeight

Methods inherited from interface org.opentrafficsim.base.Identifiable

getId

Methods inherited from interface nl.tudelft.simulation.event.EventProducerInterface

addListener, addListener, addListener, addListener, removeListener

Field Detail

DETECTOR_TRIGGERED

public static final nl.tudelft.simulation.event.EventType DETECTOR_TRIGGERED

Trigger event. Payload: [LaneBasedGTU gtu].

DETECTOR_AGGREGATE

public static final nl.tudelft.simulation.event.EventType DETECTOR_AGGREGATE

Aggregation event. Payload: [Frequency flow, other attached measurements]/

MEAN_SPEED

public static final Detector.DetectorMeasurement<Double,org.djunits.value.vdouble.scalar.Speed> MEAN_SPEED

Mean speed measurement.

HARMONIC_MEAN_SPEED

public static final Detector.DetectorMeasurement<Double,org.djunits.value.vdouble.scalar.Speed> HARMONIC_MEAN_SPEED

Harmonic mean speed measurement.

OCCUPANCY

public static final Detector.DetectorMeasurement<Double,Double> OCCUPANCY

Occupancy measurement.

PASSAGES

public static final Detector.DetectorMeasurement<List<Double>,List<Double>> PASSAGES

Passages measurement.

Constructor Detail

Detector

public Detector(String id,
                Lane lane,
                org.djunits.value.vdouble.scalar.Length longitudinalPosition,
                org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator)
         throws org.opentrafficsim.core.network.NetworkException

Constructor for regular Dutch dual-loop detectors measuring flow and mean speed aggregated over 60s.

Parameters:

id - String; detector id

lane - Lane; lane

longitudinalPosition - Length; position

simulator - OTSDEVSSimulatorInterface; simulator

Throws:

org.opentrafficsim.core.network.NetworkException - on network exception

Detector

public Detector(String id,
                Lane lane,
                org.djunits.value.vdouble.scalar.Length longitudinalPosition,
                org.djunits.value.vdouble.scalar.Length length,
                org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator,
                org.djunits.value.vdouble.scalar.Duration aggregation,
                Detector.DetectorMeasurement<?,?>... measurements)
         throws org.opentrafficsim.core.network.NetworkException

Constructor.

Parameters:

id - String; detector id

lane - Lane; lane

longitudinalPosition - Length; position

length - Length; length

simulator - OTSDEVSSimulatorInterface; simulator

aggregation - Duration; aggregation period

measurements - DetectorMeasurement...; measurements to obtain

Throws:

org.opentrafficsim.core.network.NetworkException - on network exception

Method Detail

getLength

public org.djunits.value.vdouble.scalar.Length getLength()

Returns the detector length.

Returns:

Length; the detector length

triggerResponse

protected void triggerResponse(LaneBasedGTU gtu)

Implementation of the response to a trigger of this sensor by a GTU.

Specified by:

triggerResponse in class AbstractSensor

Parameters:

gtu - LaneBasedGTU; the lane based GTU that triggered this sensor.

accumulate

<C> void accumulate(Detector.DetectorMeasurement<C,?> measurement,
                    LaneBasedGTU gtu,
                    boolean front)

Accumulates a measurement.

Type Parameters:

C - accumulated type

Parameters:

measurement - DetectorMeasurement; measurement to accumulate

gtu - LaneBasedGTU; gtu

front - boolean; triggered by front entering (or rear leaving when false)

getMesoMeasurements

public Map<Detector.DetectorMeasurement<?,?>,Object> getMesoMeasurements()

Returns a map of non-periodical measurements.

Returns:

Map<DetectorMeasurement, Object>; map of non-periodical measurements

clone

public AbstractSensor clone(CrossSectionElement newCSE,
                            org.opentrafficsim.core.dsol.OTSSimulatorInterface newSimulator,
                            boolean animation)
                     throws org.opentrafficsim.core.network.NetworkException

Clone the LaneBasedObject for e.g., copying a network.

Specified by:

clone in class AbstractSensor

Parameters:

newCSE - CrossSectionElement; the new cross section element to which the clone belongs

newSimulator - OTSSimulatorInterface; the new simulator for this network

animation - boolean; whether to (re)create animation or not

Returns:

AbstractLaneBasedObject; a clone of this object

Throws:

org.opentrafficsim.core.network.NetworkException - in case the cloning fails

writeToFile

public static final void writeToFile(org.opentrafficsim.core.network.OTSNetwork network,
                                     String file,
                                     boolean periodic)

Write the contents of all detectors in to a file.

Parameters:

network - OTSNetwork; network

file - String; file

periodic - boolean; periodic data

writeToFile

public static final <C> void writeToFile(org.opentrafficsim.core.network.OTSNetwork network,
                                         String file,
                                         boolean periodic,
                                         String format,
                                         Detector.CompressionMethod compression)

Write the contents of all detectors in to a file.

Type Parameters:

C - accumulated type

Parameters:

network - OTSNetwork; network

file - String; file

periodic - boolean; periodic data

format - String; number format, as used in String.format()

compression - how to compress the data

removeTrailingZeros

public static final String removeTrailingZeros(String string)

Remove any trailing zeros.

Parameters:

string - String; string of number

Returns:

String; string without trailing zeros

printListDouble

public static final String printListDouble(List<Double> list,
                                           String format)

Prints a list of doubles in to a formatted string.

Parameters:

list - List; double values

format - String; format string

Returns:

formatted string of doubles