org.rvpf.base.value.filter

Class LinearFilter

Object

ValueFilter.Abstract

DeadbandFilter

InterpolatorFilter

LinearFilter

All Implemented Interfaces:

ValueFilter

public class LinearFilter
extends InterpolatorFilter

Linear filter.

Nested Class Summary

Nested classes/interfaces inherited from interface ValueFilter

ValueFilter.Abstract

Field Summary

Fields inherited from class ValueFilter.Abstract

NO_POINT_VALUES

Constructor Summary

Constructors

Constructor and Description
LinearFilter(Optional<ElapsedTime> timeLimit, Optional<ElapsedTime> stampTrimUnit, double deadbangGap, double deadbandRatio) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
protected Optional<PointValue>	doFilter(PointValue pointValue) Says if a value should be filtered.
void	reset() Resets.

Methods inherited from class InterpolatorFilter

polate

Methods inherited from class DeadbandFilter

shouldFilter

Methods inherited from class ValueFilter.Abstract

filter, getHeldPointValue, getPreviousPointValue, getTimeLimit, isDisabled, pointValues, setDisabled, setHeldPointValue, setPreviousPointValue, snap, toString

Methods inherited from class Object

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

Constructor Detail

LinearFilter

public LinearFilter(@Nonnull
                    Optional<ElapsedTime> timeLimit,
                    @Nonnull
                    Optional<ElapsedTime> stampTrimUnit,
                    double deadbangGap,
                    double deadbandRatio)

Constructs an instance.

Parameters:

timeLimit - The optional time limit.

stampTrimUnit - The optional stamp trim unit.

deadbangGap - The deadband gap.

deadbandRatio - The deadband ratio.

Method Detail

reset

public void reset()

Resets.

Specified by:

reset in interface ValueFilter

Overrides:

reset in class ValueFilter.Abstract

doFilter

protected Optional<PointValue> doFilter(PointValue pointValue)

Says if a value should be filtered.

Overrides:

doFilter in class InterpolatorFilter

Parameters:

pointValue - The point value.

Returns:

Empty if it should be filtered.