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:

EventListener, EventListener

public class RoadSampler
extends Sampler<GtuDataRoad,LaneDataRoad>
implements EventListener

Implementation of kpi sampler for OTS.

Copyright (c) 2013-2024 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

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<?,?,?,? super GtuDataRoad>> extendedDataTypes, Set<FilterDataType<?,? super GtuDataRoad>> filterDataTypes, RoadNetwork network)	Constructor which uses the operational plan updates of GTU's as sampling interval.
RoadSampler(Set<ExtendedDataType<?,?,?,? super GtuDataRoad>> extendedDataTypes, Set<FilterDataType<?,? super GtuDataRoad>> 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.
boolean	equals(Object obj)
final void	finalizeRecording(LaneDataRoad lane)
int	hashCode()
final void	initRecording(LaneDataRoad lane)
final void	notify(Event event)
final Duration	now()
final void	scheduleStartRecording(Duration time, LaneDataRoad lane)
final void	scheduleStopRecording(Duration time, LaneDataRoad lane)
final String	toString()

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

addGtu, addGtuWithSnapshot, contains, getSamplerData, registerSpaceTimeRegion, removeGtu, removeGtuWithSnapshot, snapshot, 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 - the network

Throws:

NullPointerException - if the simulator is null

RoadSampler

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

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

Parameters:

extendedDataTypes - extended data types

filterDataTypes - filter data types

network - 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 - the network

frequency - sampling frequency

Throws:

NullPointerException - if an input is null

IllegalArgumentException - if frequency is negative or zero

RoadSampler

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

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

Parameters:

extendedDataTypes - extended data types

filterDataTypes - filter data types

network - the network

frequency - sampling frequency

Throws:

NullPointerException - if an input is null

IllegalArgumentException - if frequency is negative or zero

Method Details

now

public final Duration now()

Specified by:

now in class Sampler<GtuDataRoad,LaneDataRoad>

scheduleStartRecording

public final void scheduleStartRecording(Duration time,
 LaneDataRoad lane)

Specified by:

scheduleStartRecording in class Sampler<GtuDataRoad,LaneDataRoad>

scheduleStopRecording

public final void scheduleStopRecording(Duration 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(Event event)

Specified by:

notify in interface EventListener

hashCode

public int hashCode()

Overrides:

hashCode in class Sampler<GtuDataRoad,LaneDataRoad>

equals

public 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 - network

Returns:

factory to create a sampler