Package org.opentrafficsim.kpi.sampling.meta

Class FilterDataType<T>

java.lang.Object

org.opentrafficsim.kpi.sampling.meta.FilterDataType<T>

Type Parameters:

T - class of meta data

All Implemented Interfaces:

Identifiable

Direct Known Subclasses:

FilterDataCrossSections, FilterDataDestination, FilterDataGtuType, FilterDataOrigin, FilterDataRoute

public abstract class FilterDataType<T>
extends Object
implements Identifiable

Abstract class for defining a type of filter data.

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

Constructor Summary

Constructors

Constructor	Description
FilterDataType(String id, String description)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	accept(TrajectoryAcceptList trajectoryAcceptList, Set<T> querySet)	Determines for a set of trajectory's from a single GTU, which may be accepted according to this filter data type.
String	getDescription()	Returns the description.
String	getId()	Returns the id.
abstract T	getValue(GtuData gtu)	Retrieves the value of the meta data of this type from a GTU.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FilterDataType

public FilterDataType(String id,
                      String description)

Constructor.

Parameters:

id - String; id

description - String; description

Method Detail

getId

public final String getId()

Returns the id.

Specified by:

getId in interface Identifiable

Returns:

id

getValue

public abstract T getValue(GtuData gtu)

Retrieves the value of the meta data of this type from a GTU.

Parameters:

gtu - GtuData; gtu to retrieve the value from

Returns:

value of the meta data of this type from a GTU, may be null if not applicable.

accept

public void accept(TrajectoryAcceptList trajectoryAcceptList,
                   Set<T> querySet)

Determines for a set of trajectory's from a single GTU, which may be accepted according to this filter data type. As a single GTU may have several trajectories for a single TrajectoryGroup object, the specified TrajectoryGroup's may have duplicates. As the trajectory's are from a single GTU, the filter data is equal for all. Implementations of this method may for instance:

1. Determine only from the first Trajectorys' filter data that all may be accepted.
2. Determine for the separate Trajectory's whether they are acceptable.
3. The same as 2, but refuse all if any is refused.
4. The same as 2, but accept all if any is accepted.
5. etc.

The default implementation is that of 1, checking that the filter data value is in the provided query set.

Parameters:

trajectoryAcceptList - TrajectoryAcceptList; containing Trajectory's and TrajectoryGroup's pertaining to a single GTU, all assumed not accepted

querySet - Set<T>; set of values in the query for this metadata type

getDescription

public String getDescription()

Returns the description.

Returns:

String; description.

toString

public String toString()

Overrides:

toString in class Object