org.rvpf.base.value.filter

Class DeadbandFilter

Object

ValueFilter.Abstract

DeadbandFilter

All Implemented Interfaces:

ValueFilter

Direct Known Subclasses:

InterpolatorFilter, StepFilter

public class DeadbandFilter
extends ValueFilter.Abstract

Deadband 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
DeadbandFilter(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.
protected boolean	shouldFilter(Double value, Double referenceValue) Asks if a value should be filtered, considering a reference value.

Methods inherited from class ValueFilter.Abstract

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

Methods inherited from class Object

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

Constructor Detail

DeadbandFilter

public DeadbandFilter(@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

doFilter

protected Optional<PointValue> doFilter(PointValue pointValue)

Says if a value should be filtered.

Specified by:

doFilter in class ValueFilter.Abstract

Parameters:

pointValue - The point value.

Returns:

Empty if it should be filtered.

shouldFilter

@CheckReturnValue
protected boolean shouldFilter(@Nonnull
                                                  Double value,
                                                  @Nonnull
                                                  Double referenceValue)

Asks if a value should be filtered, considering a reference value.

Parameters:

value - The value.

referenceValue - The reference value.

Returns:

True if the value should be filtered.