org.opentrafficsim.imb.kpi

Class IMBSampler

java.lang.Object

org.opentrafficsim.kpi.sampling.Sampler

org.opentrafficsim.imb.kpi.IMBSampler

public class IMBSampler
extends org.opentrafficsim.kpi.sampling.Sampler

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 12 okt. 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Field Summary

Fields

Modifier and Type	Field and Description
protected GtuTypeData	defaultGtuType the default gtu type (for now).
protected RouteData	defaultRoute the default route (for now).
protected Map<String,GtuData>	gtus the gtus.
protected Map<String,LaneData>	lanes the lanes.
protected Map<String,org.opentrafficsim.kpi.sampling.KpiLaneDirection>	lastLanes last lane of gtus.
protected Map<String,LinkData>	links the links.
protected Map<String,NodeData>	nodes the nodes.

Constructor Summary

Constructors

Constructor and Description
IMBSampler(String host, int port, String modelName, int modelId, String federation) Constructor which starts the IMB connection, with listeners for nodes, links, lanes and gtu's.

Method Summary

Modifier and Type	Method and Description
void	finalizeRecording(org.opentrafficsim.kpi.sampling.KpiLaneDirection kpiLaneDirection)
void	initRecording(org.opentrafficsim.kpi.sampling.KpiLaneDirection kpiLaneDirection)
static void	main(String[] args) Main program for IMBSampler.
org.djunits.value.vdouble.scalar.Time	now()
protected void	sample(double timeStamp, String gtuId, String laneId, boolean forward, double longitudinalPosition, double speed, double acceleration) Sample the data received from a GTU.
void	scheduleStartRecording(org.djunits.value.vdouble.scalar.Time time, org.opentrafficsim.kpi.sampling.KpiLaneDirection kpiLaneDirection)
void	scheduleStopRecording(org.djunits.value.vdouble.scalar.Time time, org.opentrafficsim.kpi.sampling.KpiLaneDirection kpiLaneDirection)
protected void	updateClock(double timeStamp) Updates clock and triggers timed events.

Methods inherited from class org.opentrafficsim.kpi.sampling.Sampler

contains, equals, getTrajectoryGroup, hashCode, processGtuAddEvent, processGtuMoveEvent, processGtuRemoveEvent, processGtuRemoveEvent, registerExtendedDataType, registerMetaDataTypes, registerSpaceTimeRegion, startRecording, stopRecording

Methods inherited from class java.lang.Object

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

Field Detail

nodes

protected final Map<String,NodeData> nodes

the nodes.

links

protected final Map<String,LinkData> links

the links.

lanes

protected final Map<String,LaneData> lanes

the lanes.

gtus

protected final Map<String,GtuData> gtus

the gtus.

lastLanes

protected final Map<String,org.opentrafficsim.kpi.sampling.KpiLaneDirection> lastLanes

last lane of gtus.

defaultGtuType

protected final GtuTypeData defaultGtuType

the default gtu type (for now).

defaultRoute

protected final RouteData defaultRoute

the default route (for now).

Constructor Detail

IMBSampler

public IMBSampler(String host,
                  int port,
                  String modelName,
                  int modelId,
                  String federation)
           throws org.opentrafficsim.imb.IMBException

Constructor which starts the IMB connection, with listeners for nodes, links, lanes and gtu's.

Parameters:

host - String; name of the IMB hub

port - int; port number of the IMB hub

modelName - String; local model name

modelId - int; model id

federation - String; federation on the IMB hub

Throws:

org.opentrafficsim.imb.IMBException - when a connection to the IMB hub could not be established

Method Detail

main

public static void main(String[] args)
                 throws org.opentrafficsim.imb.IMBException

Main program for IMBSampler. Listens to events on the IMB bus and calculates and publishes statistics.

Parameters:

args - the arguments with [0]=IP address, [1]=port

Throws:

org.opentrafficsim.imb.IMBException - in case of invalid arguments

now

public final org.djunits.value.vdouble.scalar.Time now()

Specified by:

now in class org.opentrafficsim.kpi.sampling.Sampler

scheduleStartRecording

public final void scheduleStartRecording(org.djunits.value.vdouble.scalar.Time time,
                                         org.opentrafficsim.kpi.sampling.KpiLaneDirection kpiLaneDirection)

Specified by:

scheduleStartRecording in class org.opentrafficsim.kpi.sampling.Sampler

scheduleStopRecording

public final void scheduleStopRecording(org.djunits.value.vdouble.scalar.Time time,
                                        org.opentrafficsim.kpi.sampling.KpiLaneDirection kpiLaneDirection)

Specified by:

scheduleStopRecording in class org.opentrafficsim.kpi.sampling.Sampler

initRecording

public final void initRecording(org.opentrafficsim.kpi.sampling.KpiLaneDirection kpiLaneDirection)

Specified by:

initRecording in class org.opentrafficsim.kpi.sampling.Sampler

finalizeRecording

public final void finalizeRecording(org.opentrafficsim.kpi.sampling.KpiLaneDirection kpiLaneDirection)

Specified by:

finalizeRecording in class org.opentrafficsim.kpi.sampling.Sampler

sample

protected void sample(double timeStamp,
                      String gtuId,
                      String laneId,
                      boolean forward,
                      double longitudinalPosition,
                      double speed,
                      double acceleration)

Sample the data received from a GTU.

Parameters:

timeStamp -

gtuId -

laneId -

forward -

longitudinalPosition -

speed -

acceleration -

updateClock

protected void updateClock(double timeStamp)

Updates clock and triggers timed events.

Parameters:

timeStamp - most recent time stamp