FilterDataRoute (OpenTrafficSim KPI Module 1.6.0 API)

java.lang.Object
- org.opentrafficsim.kpi.sampling.meta.FilterDataType<RouteDataInterface>
- - org.opentrafficsim.kpi.sampling.meta.FilterDataRoute

All Implemented Interfaces:

Identifiable
```
public class FilterDataRoute
extends FilterDataType<RouteDataInterface>
```
Accepts trajectories with a Route included in a set in a query.
Copyright (c) 2013-2022 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 Sep 22, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Constructor Summary

Constructors
Constructor Description

FilterDataRoute()
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`formatValue(String format, RouteDataInterface value)`	Formats the value into a string.
`RouteDataInterface`	`getValue(GtuDataInterface gtu)`	Retrieves the value of the meta data of this type from a GTU.
`String`	`toString()`

Methods inherited from class org.opentrafficsim.kpi.sampling.meta.FilterDataType
accept, getId

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

- Constructor Detail
  - FilterDataRoute
```
public FilterDataRoute()
```
    Constructor.
- Method Detail
  - getValue
```
public final RouteDataInterface getValue(GtuDataInterface gtu)
```
    Retrieves the value of the meta data of this type from a GTU.
    
    Specified by:
    
    getValue in class FilterDataType<RouteDataInterface>
    
    Parameters:
    
    gtu - GtuDataInterface; gtu to retrieve the value from
    
    Returns:
    
    value of the meta data of this type from a GTU, may be null if not applicable.
  - formatValue
```
public String formatValue(String format,
                          RouteDataInterface value)
```
    Formats the value into a string. If the value is numeric, the default implementation is:
    String.format(format, value.si);
    Specified by:
    
    formatValue in class FilterDataType<RouteDataInterface>
    
    Parameters:
    
    format - String; format
    
    value - T; value
    
    Returns:
    
    formatted value
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class FilterDataType<RouteDataInterface>