org.vesalainen.nmea.util

Class NMEAFilters

java.lang.Object

org.vesalainen.nmea.util.NMEAFilters

public class NMEAFilters
extends Object

Filters for NMEASample streams

These filters are recycling! No need to use Streams.recyclingPredicate method.

Author:

tkv

See Also:

Streams.recyclingPredicate(java.util.function.Predicate)

Constructor Summary

Constructors

Constructor and Description
NMEAFilters()

Method Summary

Modifier and Type	Method and Description
static java.util.function.UnaryOperator<NMEASample>	accumulatorMap() Returns map that accumulates previous properties to sample.
static java.util.stream.Stream<NMEASample>	bearingToleranceFilter(java.util.stream.Stream<NMEASample> stream, double bearingTolerance) Returns filter that filters waypoints which bearing differs less that bearingTolerance in degrees from previous waypoint.
static java.util.function.Predicate<NMEASample>	containsAllFilter(String... properties) This filter passes only samples that have all of given properties.
static java.util.function.Predicate<NMEASample>	locationFilter(float maxAcceleration) Creates filter locations.
static java.util.function.Predicate<NMEASample>	minDistanceFilter(double minDistance) Creates filter that filters locations until minDistance is moved
static java.util.function.Predicate<NMEASample>	periodicFilter(long period, TimeUnit unit) Creates a filter that filters samples so, that no two samples have time closer than period.
static java.util.function.Predicate<NMEASample>	propertyAccelerationFilter(String property, float maxAcceleration) Creates acceleration filter for property
static java.util.function.Predicate<NMEASample>	rangeFilter(String property, float min, float max) Creates range filter for property
static java.util.function.Predicate<NMEASample>	timeFilter() Creates time filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

NMEAFilters

public NMEAFilters()

Method Detail

periodicFilter

public static final java.util.function.Predicate<NMEASample> periodicFilter(long period,
                                                                            TimeUnit unit)

Creates a filter that filters samples so, that no two samples have time closer than period.

Use with accumulatorMap and containsAllFilter to make sure all needed properties are present.

Parameters:

period -

unit -

Returns:

containsAllFilter

public static final java.util.function.Predicate<NMEASample> containsAllFilter(String... properties)

This filter passes only samples that have all of given properties.

Parameters:

properties -

Returns:

accumulatorMap

public static final java.util.function.UnaryOperator<NMEASample> accumulatorMap()

Returns map that accumulates previous properties to sample.

Returns:

bearingToleranceFilter

public static final java.util.stream.Stream<NMEASample> bearingToleranceFilter(java.util.stream.Stream<NMEASample> stream,
                                                                               double bearingTolerance)

Returns filter that filters waypoints which bearing differs less that bearingTolerance in degrees from previous waypoint.

This is used to filter waypoints which can be replaced by line in.

Parameters:

stream -

bearingTolerance -

Returns:

minDistanceFilter

public static final java.util.function.Predicate<NMEASample> minDistanceFilter(double minDistance)

Creates filter that filters locations until minDistance is moved

Parameters:

minDistance - in NM

Returns:

locationFilter

public static final java.util.function.Predicate<NMEASample> locationFilter(float maxAcceleration)

Creates filter locations. Dropping sample when acceleration exceeds given limit.

Parameters:

maxAcceleration - Maximum speed change in second in knots.

Returns:

propertyAccelerationFilter

public static final java.util.function.Predicate<NMEASample> propertyAccelerationFilter(String property,
                                                                                        float maxAcceleration)

Creates acceleration filter for property

Parameters:

property -

maxAcceleration - Maximum value change in second in property unit.

Returns:

rangeFilter

public static final java.util.function.Predicate<NMEASample> rangeFilter(String property,
                                                                         float min,
                                                                         float max)

Creates range filter for property

Parameters:

property -

min -

max -

Returns:

timeFilter

public static final java.util.function.Predicate<NMEASample> timeFilter()

Creates time filter. Filters samples with no time or time in past.

Returns: