Package org.opentrafficsim.road.network.sampling

Class RoadSampler

java.lang.Object

org.opentrafficsim.kpi.sampling.Sampler<GtuDataRoad,LaneDataRoad>

org.opentrafficsim.road.network.sampling.RoadSampler

All Implemented Interfaces:

Serializable, Remote, EventListener, org.djutils.event.EventListener

public class RoadSampler
extends Sampler<GtuDataRoad,LaneDataRoad>
implements org.djutils.event.EventListener

Implementation of kpi sampler for OTS.

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

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
RoadSampler(Set<ExtendedDataType<?,?,?,GtuDataRoad>> extendedDataTypes, Set<FilterDataType<?>> filterDataTypes, RoadNetwork network)	Constructor which uses the operational plan updates of GTU's as sampling interval.
RoadSampler(Set<ExtendedDataType<?,?,?,GtuDataRoad>> extendedDataTypes, Set<FilterDataType<?>> filterDataTypes, RoadNetwork network, Frequency frequency)	Constructor which uses the given frequency to determine the sampling interval.
RoadSampler(RoadNetwork network)	Constructor which uses the operational plan updates of GTU's as sampling interval.
RoadSampler(RoadNetwork 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(RoadNetwork network)	Returns a factory to create a sampler.
final boolean	equals(Object obj)
final void	finalizeRecording(LaneDataRoad lane)
final int	hashCode()
final void	initRecording(LaneDataRoad lane)
final void	notify(org.djutils.event.Event event)
final void	notifySample(LaneBasedGtu gtu, Lane lane)	Samples a gtu and schedules the next sampling event.
final Time	now()
final void	scheduleStartRecording(Time time, LaneDataRoad lane)
final void	scheduleStopRecording(Time time, LaneDataRoad lane)
final String	toString()

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

RoadSampler

public RoadSampler(RoadNetwork network)

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

Parameters:

network - RoadNetwork; the network

Throws:

NullPointerException - if the simulator is null

RoadSampler

public RoadSampler(Set<ExtendedDataType<?,?,?,GtuDataRoad>> extendedDataTypes,
 Set<FilterDataType<?>> filterDataTypes,
 RoadNetwork 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 - RoadNetwork; the network

Throws:

NullPointerException - if the simulator is null

RoadSampler

public RoadSampler(RoadNetwork network,
 Frequency frequency)

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

Parameters:

network - RoadNetwork; the network

frequency - Frequency; sampling frequency

Throws:

NullPointerException - if an input is null

IllegalArgumentException - if frequency is negative or zero

RoadSampler

public RoadSampler(Set<ExtendedDataType<?,?,?,GtuDataRoad>> extendedDataTypes,
 Set<FilterDataType<?>> filterDataTypes,
 RoadNetwork network,
 Frequency frequency)

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

Parameters:

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

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

network - RoadNetwork; the network

frequency - Frequency; sampling frequency

Throws:

NullPointerException - if an input is null

IllegalArgumentException - if frequency is negative or zero

Method Details

now

public final Time now()

Specified by:

now in class Sampler<GtuDataRoad,LaneDataRoad>

scheduleStartRecording

public final void scheduleStartRecording(Time time,
 LaneDataRoad lane)

Specified by:

scheduleStartRecording in class Sampler<GtuDataRoad,LaneDataRoad>

scheduleStopRecording

public final void scheduleStopRecording(Time time,
 LaneDataRoad lane)

Specified by:

scheduleStopRecording in class Sampler<GtuDataRoad,LaneDataRoad>

initRecording

public final void initRecording(LaneDataRoad lane)

Specified by:

initRecording in class Sampler<GtuDataRoad,LaneDataRoad>

finalizeRecording

public final void finalizeRecording(LaneDataRoad lane)

Specified by:

finalizeRecording in class Sampler<GtuDataRoad,LaneDataRoad>

notify

public final void notify(org.djutils.event.Event event)
                  throws RemoteException

Specified by:

notify in interface org.djutils.event.EventListener

Throws:

RemoteException

notifySample

public final void notifySample(LaneBasedGtu gtu,
 Lane lane)

Samples a gtu and schedules the next sampling event. This is used for interval-based sampling.

Parameters:

gtu - LaneBasedGtu; gtu to sample

lane - Lane; lane direction where the gtu is at

hashCode

public final int hashCode()

Overrides:

hashCode in class Sampler<GtuDataRoad,LaneDataRoad>

equals

public final boolean equals(Object obj)

Overrides:

equals in class Sampler<GtuDataRoad,LaneDataRoad>

toString

public final String toString()

Overrides:

toString in class Object

build

public static RoadSampler.Factory build(RoadNetwork network)

Returns a factory to create a sampler.

Parameters:

network - RoadNetwork; network

Returns:

Factory; factory to create a sampler