org.rvpf.base.value.filter

Class ValueFilter.Abstract

Object

ValueFilter.Abstract

All Implemented Interfaces:

ValueFilter

Direct Known Subclasses:

DeadbandFilter

Enclosing interface:

ValueFilter

public abstract static class ValueFilter.Abstract
extends Object
implements ValueFilter

Nested Class Summary

Nested classes/interfaces inherited from interface ValueFilter

ValueFilter.Abstract

Field Summary

Fields

Modifier and Type	Field and Description
protected static PointValue[]	NO_POINT_VALUES No point values.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Abstract(Optional<ElapsedTime> timeLimit, Optional<ElapsedTime> stampTrimUnit) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
protected abstract Optional<PointValue>	doFilter(PointValue pointValue) Says if a value should be filtered.
PointValue[]	filter(Optional<PointValue> optionalPointValue) Filters a point value.
protected Optional<PointValue>	getHeldPointValue() Gets the held point value.
protected Optional<PointValue>	getPreviousPointValue() Gets the previous point value.
protected Optional<ElapsedTime>	getTimeLimit() Gets the time limit.
boolean	isDisabled() Gets the disabled indicator.
protected PointValue[]	pointValues(PointValue... pointValues) Returns the point values into an array.
void	reset() Resets.
protected void	setDisabled(boolean disabled) Sets the disabled indicator.
protected void	setHeldPointValue(PointValue heldPointValue) Sets the held point value.
protected void	setPreviousPointValue(PointValue previousValue) Sets the previous point value.
protected PointValue	snap(PointValue pointValue) Snaps the point value.
String	toString()

Methods inherited from class Object

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

Field Detail

NO_POINT_VALUES

protected static final PointValue[] NO_POINT_VALUES

No point values.

Constructor Detail

Abstract

protected Abstract(@Nonnull
                   Optional<ElapsedTime> timeLimit,
                   @Nonnull
                   Optional<ElapsedTime> stampTrimUnit)

Constructs an instance.

Parameters:

timeLimit - The optional time limit.

stampTrimUnit - The optional stamp trim unit.

Method Detail

filter

public final PointValue[] filter(Optional<PointValue> optionalPointValue)

Filters a point value.

When a value filter needs to return a modified point value, if the supplied one is frozen, it will return a frozen but modified clone; otherwise, it will return the original with the needed modifications but frozen.

Specified by:

filter in interface ValueFilter

Parameters:

optionalPointValue - The optional point value.

Returns:

Filtered point values.

isDisabled

public final boolean isDisabled()

Gets the disabled indicator.

Specified by:

isDisabled in interface ValueFilter

Returns:

The disabled indicator.

reset

public void reset()

Resets.

Specified by:

reset in interface ValueFilter

toString

public String toString()

Overrides:

toString in class Object

doFilter

@Nonnull
 @CheckReturnValue
protected abstract Optional<PointValue> doFilter(@Nonnull
                                                                               PointValue pointValue)

Says if a value should be filtered.

Parameters:

pointValue - The point value.

Returns:

Empty if it should be filtered.

getHeldPointValue

@Nonnull
 @CheckReturnValue
protected final Optional<PointValue> getHeldPointValue()

Gets the held point value.

Returns:

The optional held point value.

getPreviousPointValue

@Nonnull
 @CheckReturnValue
protected final Optional<PointValue> getPreviousPointValue()

Gets the previous point value.

Returns:

The optional previous point value.

getTimeLimit

@Nonnull
 @CheckReturnValue
protected final Optional<ElapsedTime> getTimeLimit()

Gets the time limit.

Returns:

The optional time limit.

pointValues

@Nonnull
 @CheckReturnValue
protected PointValue[] pointValues(PointValue... pointValues)

Returns the point values into an array.

Parameters:

pointValues - The point values.

Returns:

The point value array.

setDisabled

protected final void setDisabled(boolean disabled)

Sets the disabled indicator.

Parameters:

disabled - The disabled indicator.

setHeldPointValue

protected final void setHeldPointValue(@Nonnull
                                       PointValue heldPointValue)

Sets the held point value.

Parameters:

heldPointValue - The held point value.

setPreviousPointValue

protected final void setPreviousPointValue(@Nonnull
                                           PointValue previousValue)

Sets the previous point value.

Parameters:

previousValue - The previous value.

snap

@Nonnull
 @CheckReturnValue
protected PointValue snap(@Nonnull
                                                        PointValue pointValue)

Snaps the point value.

Parameters:

pointValue - The point value.

Returns:

The snapped point value.