org.rvpf.base.value.filter

Interface ValueFilter

All Known Implementing Classes:

DeadbandFilter, DisabledFilter, InterpolatorFilter, LinearFilter, StepFilter, ValueFilter.Abstract

public interface ValueFilter

Value filter.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ValueFilter.Abstract

Method Summary

Modifier and Type	Method and Description
PointValue[]	filter(Optional<PointValue> pointValue) Filters a point value.
boolean	isDisabled() Gets the disabled indicator.
void	reset() Resets.

Method Detail

filter

@Nonnull
 @CheckReturnValue
PointValue[] filter(@Nonnull
                                                  Optional<PointValue> pointValue)

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.

Parameters:

pointValue - The optional point value.

Returns:

Filtered point values.

isDisabled

@CheckReturnValue
boolean isDisabled()

Gets the disabled indicator.

Returns:

The disabled indicator.

reset

void reset()

Resets.