Package edu.wpi.first.wpilibj.filters
Class Filter
- java.lang.Object
-
- edu.wpi.first.wpilibj.filters.Filter
-
- All Implemented Interfaces:
PIDSource
- Direct Known Subclasses:
LinearDigitalFilter
@Deprecated(since="2020", forRemoval=true) public abstract class Filter extends Object implements PIDSource
Deprecated, for removal: This API element is subject to removal in a future version.This class is no longer used.Superclass for filters.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description abstract doubleget()Deprecated, for removal: This API element is subject to removal in a future version.Returns the current filter estimate without also inserting new data as pidGet() would do.PIDSourceTypegetPIDSourceType()Deprecated, for removal: This API element is subject to removal in a future version.Get which parameter of the device you are using as a process control variable.abstract doublepidGet()Deprecated, for removal: This API element is subject to removal in a future version.Get the result to use in PIDController.protected doublepidGetSource()Deprecated, for removal: This API element is subject to removal in a future version.Calls PIDGet() of source.abstract voidreset()Deprecated, for removal: This API element is subject to removal in a future version.Reset the filter state.voidsetPIDSourceType(PIDSourceType pidSource)Deprecated, for removal: This API element is subject to removal in a future version.Set which parameter of the device you are using as a process control variable.
-
-
-
Constructor Detail
-
Filter
public Filter(PIDSource source)
Deprecated, for removal: This API element is subject to removal in a future version.
-
-
Method Detail
-
setPIDSourceType
public void setPIDSourceType(PIDSourceType pidSource)
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PIDSourceSet which parameter of the device you are using as a process control variable.- Specified by:
setPIDSourceTypein interfacePIDSource- Parameters:
pidSource- An enum to select the parameter.
-
getPIDSourceType
public PIDSourceType getPIDSourceType()
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PIDSourceGet which parameter of the device you are using as a process control variable.- Specified by:
getPIDSourceTypein interfacePIDSource- Returns:
- the currently selected PID source parameter
-
pidGet
public abstract double pidGet()
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:PIDSourceGet the result to use in PIDController.
-
get
public abstract double get()
Deprecated, for removal: This API element is subject to removal in a future version.Returns the current filter estimate without also inserting new data as pidGet() would do.- Returns:
- The current filter estimate
-
reset
public abstract void reset()
Deprecated, for removal: This API element is subject to removal in a future version.Reset the filter state.
-
pidGetSource
protected double pidGetSource()
Deprecated, for removal: This API element is subject to removal in a future version.Calls PIDGet() of source.- Returns:
- Current value of source
-
-