RoadSampler.Factory (OpenTrafficSim road classes 1.6.0 API)

java.lang.Object
- org.opentrafficsim.road.network.sampling.RoadSampler.Factory

Enclosing class:: RoadSampler

public static final class RoadSampler.Factory
extends Object

Factory for RoadSampler.

Constructor Summary

Constructors
Constructor Description

Factory(OTSRoadNetwork network)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`RoadSampler`	`create()`	Create sampler.
`RoadSampler.Factory`	`registerExtendedDataType(ExtendedDataType<?,?,?,GtuData> extendedDataType)`	Register extended data type.
`RoadSampler.Factory`	`registerFilterDataType(FilterDataType<?> filterDataType)`	Register filter data type.
`RoadSampler.Factory`	`setFrequency(Frequency frequency)`	Sets the frequency.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Factory
```
Factory(OTSRoadNetwork network)
```
    Constructor.
    
    Parameters:
    
    network - OTSRoadNetwork; network
- Method Detail
  - registerExtendedDataType
```
public RoadSampler.Factory registerExtendedDataType(ExtendedDataType<?,?,?,GtuData> extendedDataType)
```
    Register extended data type.
    
    Parameters:
    
    extendedDataType - ExtendedDataType<?, ?, ?, GtuData>; extended data type
    
    Returns:
    
    Factory; this factory
  - registerFilterDataType
```
public RoadSampler.Factory registerFilterDataType(FilterDataType<?> filterDataType)
```
    Register filter data type.
    
    Parameters:
    
    filterDataType - FilterDataType<?>; filter data type
    
    Returns:
    
    Factory; this factory
  - setFrequency
```
public RoadSampler.Factory setFrequency(Frequency frequency)
```
    Sets the frequency. If no frequency is set, a sampler is created that records on move events of GTU's.
    
    Parameters:
    
    frequency - Frequency; frequency
    
    Returns:
    
    Factory; this factory
  - create
```
public RoadSampler create()
```
    Create sampler.
    
    Returns:
    
    RoadSampler; sampler