org.rvpf.base.value.filter

Class StepFilter

Object

ValueFilter.Abstract

DeadbandFilter

StepFilter

All Implemented Interfaces:

ValueFilter

public final class StepFilter
extends DeadbandFilter

Step 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
StepFilter(Optional<ElapsedTime> timeLimit, Optional<ElapsedTime> trimUnit, double deadbangGap, double deadbandRatio, double stepSize, double ceilingGap, double floorGap) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
protected PointValue	snap(PointValue pointValue) Snaps the point value.

Methods inherited from class DeadbandFilter

doFilter, shouldFilter

Methods inherited from class ValueFilter.Abstract

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

Methods inherited from class Object

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

Constructor Detail

StepFilter

public StepFilter(@Nonnull
                  Optional<ElapsedTime> timeLimit,
                  @Nonnull
                  Optional<ElapsedTime> trimUnit,
                  double deadbangGap,
                  double deadbandRatio,
                  double stepSize,
                  double ceilingGap,
                  double floorGap)

Constructs an instance.

Parameters:

timeLimit - The optional time limit.

trimUnit - The optional trim unit.

deadbangGap - The deadband gap.

deadbandRatio - The deadband ratio.

stepSize - The step size.

ceilingGap - The ceiling gap.

floorGap - The floor gap.

Method Detail

snap

protected PointValue snap(PointValue pointValue)

Snaps the point value.

Overrides:

snap in class ValueFilter.Abstract

Parameters:

pointValue - The point value.

Returns:

The snapped point value.