org.opentrafficsim.imb.transceiver.urbanstrategy

Class StatisticsGTULaneTransceiver

java.lang.Object

nl.tudelft.simulation.event.EventProducer

org.opentrafficsim.imb.transceiver.AbstractTransceiver

org.opentrafficsim.imb.transceiver.urbanstrategy.StatisticsGTULaneTransceiver

All Implemented Interfaces:

Serializable, EventListener, nl.tudelft.simulation.event.EventListenerInterface, nl.tudelft.simulation.event.EventProducerInterface, org.opentrafficsim.imb.transceiver.EventTransceiver, org.opentrafficsim.imb.transceiver.Transceiver

public class StatisticsGTULaneTransceiver
extends AbstractTransceiver

OTS can publish messages about statistics or Key Performance Indicators (KPIs) of the relation between GTUs and a part of the network. Examples are average speeds, travel times, trip durations, and number of stops. The statistics can be transmitted via IMB at certain intervals. The statistics are based on the classes in the ots.road.sampling package. Most statistics consider a time interval (can be unbound) and a region in space (a collection of lanes; can be the entire network), filtered on metadata such as GTU type, origin, destination, or route.
When a statistic is published for the first time, a NEW message is sent to IMB to identify the type of statistic, the time interval and the lane(s) for which the statistic is calculated, and the metadata used to filter the GTUs. The CHANGE message is posted whenever an updated statistic is available, or when the sample frequency time is reached. When a statistic is no longer published, a DELETE event is posted. The Graph NEW messages are posted after the Network NEW, Node NEW, Link NEW, and Lane NEW messages are posted, as it has to be able to identify Lanes.

NEW

Variable	Type	Comments
timestamp	double	time of the event, in simulation time seconds
statisticId	String	a unique id for the statistic, e.g. a UUID string
description	String	textual description of the statistic
networkId	String	id of the Network for which the statistic is made
numberMetadataEntries	int	number of metadata entries
metadataId_1	String	id of the first metadata entry
metadataType_1	String	type of metadata, one of GTUTYPE, ORIGIN, DESTINATION, ROUTE
metadataValue_1	String	value of the first metadata entry
...
metadataId_n	String
metadataType_n	String	type of metadata, one of GTUTYPE, ORIGIN, DESTINATION, ROUTE
metadataValue_n	String	value of the last metadata entry
numberSpaceTimeRegions	int	number of space-time regions for this statistic
startTime_1	double	start time for the first space time region, in seconds
endTime_1	double	end time for the first space time region, in seconds
linkId_1	String	id of the first Link for the space-time region
laneId_1	String	id of the first Lane in the link for the space-time region
...
startTime_n	double	start time for the last space time region, in seconds
endTime_n	double	end time for the last space time region, in seconds
linkId_n	String	id of the last Link for the space-time region
laneId_n	String	id of the last Lane in the link for the space-time region
connected	boolean	whether the lanes in the space-time regions are longitudinally connected or not
transmissionInterval	double	transmission interval of the statistic in seconds

CHANGE

Variable	Type	Comments
timestamp	double	time of the event, in simulation time seconds
statisticId	String	the unique id for the statistic, e.g. a UUID string
totalGtuDistance	double	total distance traveled by filtered GTUs in the given time and space, in meters
totalGtuTravelTime	double	total travel time by filtered GTUs in the given time and space, in seconds
averageGtuSpeed	double	average filtered GTU speed in the given time and space, in meter/second
averageGtuTravelTimePerDistance	double	average filtered GTU travel time in the given time and space, in seconds per km
totalGtuTimeDelay	double	total time delay incurred by the filtered GTUs in the given time and space, in seconds
averageTripLength	double	average length of the trip of the filtered GTUs in the given time and space, in seconds
totalNumberStops	double	total number of stops that GTUs made in the given time and space, dimensionless

DELETE

Variable	Type	Comments
timestamp	double	time of the event, in simulation time seconds
statisticId	String	the unique id for the statistic that is removed

Copyright (c) 2013-2016 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 Sep 16, 2016

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	StatisticsGTULaneTransceiver.StatisticsRunnable Copyright (c) 2013-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) org.opentrafficsim.kpi.sampling.indicator.MeanSpeed	meanSpeed Mean speed.
(package private) org.opentrafficsim.kpi.sampling.indicator.MeanTravelTimePerDistance	meanTravelTimePerDistance Mean travel time per km.
(package private) org.opentrafficsim.kpi.sampling.indicator.MeanTripLength	meanTripLength Mean trip length.
(package private) org.opentrafficsim.kpi.sampling.Query	query The query for the statistic.
(package private) static org.opentrafficsim.road.network.sampling.data.ReferenceSpeed	REF_SPEED_TYPE Reference speed extended data type.
(package private) org.opentrafficsim.kpi.sampling.indicator.TotalDelay	totalDelay Total delay.
(package private) org.opentrafficsim.road.network.sampling.indicator.TotalDelayReference	totalDelayReference Total delay with reference.
(package private) org.opentrafficsim.kpi.sampling.indicator.TotalNumberOfStops	totalNumberOfStops Total number of stops.
(package private) org.opentrafficsim.kpi.sampling.indicator.TotalTravelDistance	totalTravelDistance Total travel distance.
(package private) org.opentrafficsim.kpi.sampling.indicator.TotalTravelTime	totalTravelTime Total travel time.
(package private) org.djunits.value.vdouble.scalar.Duration	transmissionInterval The interval between generation of graphs.

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

listeners

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

FIRST_POSITION, LAST_POSITION

Constructor Summary

Constructors

Constructor and Description
StatisticsGTULaneTransceiver(org.opentrafficsim.imb.connector.Connector connector, org.opentrafficsim.simulationengine.SimpleSimulatorInterface simulator, String networkId, org.opentrafficsim.kpi.sampling.Query query, org.djunits.value.vdouble.scalar.Duration transmissionInterval) Construct a new StatisticsGTULaneTransceiver.

Method Summary

Modifier and Type	Method and Description
void	sendStatisticsUpdate()

Methods inherited from class org.opentrafficsim.imb.transceiver.AbstractTransceiver

addIMBtoOTSChannel, addIMBtoOTSChannel, addOTSToIMBChannel, getConnector, getId, getSimulator, handleMessageFromIMB, notify, removeOTSToIMBChannel, toString

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

addListener, addListener, addListener, addListener, removeListener

Field Detail

REF_SPEED_TYPE

static final org.opentrafficsim.road.network.sampling.data.ReferenceSpeed REF_SPEED_TYPE

Reference speed extended data type.

query

final org.opentrafficsim.kpi.sampling.Query query

The query for the statistic.

transmissionInterval

final org.djunits.value.vdouble.scalar.Duration transmissionInterval

The interval between generation of graphs.

totalTravelDistance

org.opentrafficsim.kpi.sampling.indicator.TotalTravelDistance totalTravelDistance

Total travel distance.

totalTravelTime

org.opentrafficsim.kpi.sampling.indicator.TotalTravelTime totalTravelTime

Total travel time.

meanSpeed

org.opentrafficsim.kpi.sampling.indicator.MeanSpeed meanSpeed

Mean speed.

meanTravelTimePerDistance

org.opentrafficsim.kpi.sampling.indicator.MeanTravelTimePerDistance meanTravelTimePerDistance

Mean travel time per km.

meanTripLength

org.opentrafficsim.kpi.sampling.indicator.MeanTripLength meanTripLength

Mean trip length.

totalDelay

org.opentrafficsim.kpi.sampling.indicator.TotalDelay totalDelay

Total delay.

totalDelayReference

org.opentrafficsim.road.network.sampling.indicator.TotalDelayReference totalDelayReference

Total delay with reference.

totalNumberOfStops

org.opentrafficsim.kpi.sampling.indicator.TotalNumberOfStops totalNumberOfStops

Total number of stops.

Constructor Detail

StatisticsGTULaneTransceiver

public StatisticsGTULaneTransceiver(org.opentrafficsim.imb.connector.Connector connector,
                                    org.opentrafficsim.simulationengine.SimpleSimulatorInterface simulator,
                                    String networkId,
                                    org.opentrafficsim.kpi.sampling.Query query,
                                    org.djunits.value.vdouble.scalar.Duration transmissionInterval)
                             throws org.opentrafficsim.imb.IMBException

Construct a new StatisticsGTULaneTransceiver.

Parameters:

connector - Connector; the IMB connector

simulator - SimpleSimulatorInterface; the simulator

networkId - String; the network id

query - Query; the statistics query

transmissionInterval - Duration; the interval between generation of graphs

Throws:

org.opentrafficsim.imb.IMBException - when the message cannot be posted, or the scheduling of the publish event fails

Method Detail

sendStatisticsUpdate

public void sendStatisticsUpdate()
                          throws org.opentrafficsim.imb.IMBException,
                                 SimRuntimeException

Throws:

org.opentrafficsim.imb.IMBException - when the transmission of the IMB message fails

SimRuntimeException - when the scheduling of the next publish event fails