Package org.opentrafficsim.road.network.sampling

Class RoadSampler

java.lang.Object

org.opentrafficsim.kpi.sampling.Sampler<GtuData>

org.opentrafficsim.road.network.sampling.RoadSampler

All Implemented Interfaces:

java.io.Serializable, java.util.EventListener, EventListenerInterface

public class RoadSampler
extends Sampler<GtuData>
implements EventListenerInterface

Implementation of kpi sampler for OTS.

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

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RoadSampler.Factory	Factory for RoadSampler.

Constructor Summary

Constructors

Constructor	Description
RoadSampler(java.util.Set<ExtendedDataType<?,?,?,GtuData>> extendedDataTypes, java.util.Set<FilterDataType<?>> filterDataTypes, OTSRoadNetwork network)	Constructor which uses the operational plan updates of GTU's as sampling interval.
RoadSampler(java.util.Set<ExtendedDataType<?,?,?,GtuData>> extendedDataTypes, java.util.Set<FilterDataType<?>> filterDataTypes, OTSRoadNetwork network, Frequency frequency)	Constructor which uses the given frequency to determine the sampling interval.
RoadSampler(OTSRoadNetwork network)	Constructor which uses the operational plan updates of GTU's as sampling interval.
RoadSampler(OTSRoadNetwork network, Frequency frequency)	Constructor which uses the given frequency to determine the sampling interval.

Method Summary

Modifier and Type	Method	Description
static RoadSampler.Factory	build(OTSRoadNetwork network)	Returns a factory to create a sampler.
boolean	equals(java.lang.Object obj)
void	finalizeRecording(KpiLaneDirection kpiLaneDirection)
int	hashCode()
void	initRecording(KpiLaneDirection kpiLaneDirection)
void	notify(EventInterface event)
void	notifySample(LaneBasedGTU gtu, LaneDirection laneDirection)	Samples a gtu and schedules the next sampling event.
Time	now()
void	scheduleStartRecording(Time time, KpiLaneDirection kpiLaneDirection)
void	scheduleStopRecording(Time time, KpiLaneDirection kpiLaneDirection)
java.lang.String	toString()

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

contains, getSamplerData, processGtuAddEvent, processGtuMoveEvent, processGtuRemoveEvent, processGtuRemoveEvent, registerSpaceTimeRegion, startRecording, stopRecording

Methods inherited from class java.lang.Object

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

Constructor Detail

RoadSampler

public RoadSampler(OTSRoadNetwork network)

Constructor which uses the operational plan updates of GTU's as sampling interval.

Parameters:

network - OTSRoadNetwork; the network

Throws:

java.lang.NullPointerException - if the simulator is null

RoadSampler

public RoadSampler(java.util.Set<ExtendedDataType<?,?,?,GtuData>> extendedDataTypes,
                   java.util.Set<FilterDataType<?>> filterDataTypes,
                   OTSRoadNetwork network)

Constructor which uses the operational plan updates of GTU's as sampling interval.

Parameters:

extendedDataTypes - Set<ExtendedDataType<?, ?, ?, GtuData>>; extended data types

filterDataTypes - Set<FilterDataType<?>>; filter data types

network - OTSRoadNetwork; the network

Throws:

java.lang.NullPointerException - if the simulator is null

RoadSampler

public RoadSampler(OTSRoadNetwork network,
                   Frequency frequency)

Constructor which uses the given frequency to determine the sampling interval.

Parameters:

network - OTSRoadNetwork; the network

frequency - Frequency; sampling frequency

Throws:

java.lang.NullPointerException - if an input is null

java.lang.IllegalArgumentException - if frequency is negative or zero

RoadSampler

public RoadSampler(java.util.Set<ExtendedDataType<?,?,?,GtuData>> extendedDataTypes,
                   java.util.Set<FilterDataType<?>> filterDataTypes,
                   OTSRoadNetwork network,
                   Frequency frequency)

Constructor which uses the given frequency to determine the sampling interval.

Parameters:

extendedDataTypes - Set<ExtendedDataType<?, ?, ?, GGtuData>>; extended data types

filterDataTypes - Set<FilterDataType<?>>; filter data types

network - OTSRoadNetwork; the network

frequency - Frequency; sampling frequency

Throws:

java.lang.NullPointerException - if an input is null

java.lang.IllegalArgumentException - if frequency is negative or zero

Method Detail

now

public final Time now()

Specified by:

now in class Sampler<GtuData>

scheduleStartRecording

public final void scheduleStartRecording(Time time,
                                         KpiLaneDirection kpiLaneDirection)

Specified by:

scheduleStartRecording in class Sampler<GtuData>

scheduleStopRecording

public final void scheduleStopRecording(Time time,
                                        KpiLaneDirection kpiLaneDirection)

Specified by:

scheduleStopRecording in class Sampler<GtuData>

initRecording

public final void initRecording(KpiLaneDirection kpiLaneDirection)

Specified by:

initRecording in class Sampler<GtuData>

finalizeRecording

public final void finalizeRecording(KpiLaneDirection kpiLaneDirection)

Specified by:

finalizeRecording in class Sampler<GtuData>

notify

public final void notify(EventInterface event)
                  throws java.rmi.RemoteException

Specified by:

notify in interface EventListenerInterface

Throws:

java.rmi.RemoteException

notifySample

public final void notifySample(LaneBasedGTU gtu,
                               LaneDirection laneDirection)

Samples a gtu and schedules the next sampling event.

Parameters:

gtu - LaneBasedGTU; gtu to sample

laneDirection - LaneDirection; lane direction where the gtu is at

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

build

public static RoadSampler.Factory build(OTSRoadNetwork network)

Returns a factory to create a sampler.

Parameters:

network - OTSRoadNetwork; network

Returns:

Factory; factory to create a sampler