Package org.opentrafficsim.sim0mq.kpi

Class Sim0MQKpiTransceiver

java.lang.Object
org.opentrafficsim.sim0mq.kpi.Sim0MQKpiTransceiver
All Implemented Interfaces:
java.io.Serializable
public class Sim0MQKpiTransceiver
extends java.lang.Object
implements java.io.Serializable
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 id of the last metadata entry
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
averageGtuTravelTimePerKm 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-2020 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

  • Constructor Summary

    Constructors 
    Constructor Description
    Sim0MQKpiTransceiver()  

  • Method Summary

    Methods inherited from class java.lang.Object

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