Enum Class BiquadFilter.Kind

java.lang.Object

java.lang.Enum<BiquadFilter.Kind>

org.wpilib.math.filter.BiquadFilter.Kind

All Implemented Interfaces:

Serializable, Comparable<BiquadFilter.Kind>, Constable

Enclosing class:

BiquadFilter

public static enum BiquadFilter.Kind
extends Enum<BiquadFilter.Kind>

Frequency response shape for the classical IIR design factories. For BandPass/BandStop, two cutoff frequencies (f1, f2) are required.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BandPass	Band-pass filter (passes a frequency band).
BandStop	Band-stop filter (rejects a frequency band).
HighPass	High-pass filter (passes frequencies above the cutoff).
LowPass	Low-pass filter (passes frequencies below the cutoff).

Method Summary

Modifier and Type	Method	Description
static BiquadFilter.Kind	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BiquadFilter.Kind[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LowPass

public static final BiquadFilter.Kind LowPass

Low-pass filter (passes frequencies below the cutoff).

HighPass

public static final BiquadFilter.Kind HighPass

High-pass filter (passes frequencies above the cutoff).

BandPass

public static final BiquadFilter.Kind BandPass

Band-pass filter (passes a frequency band).

BandStop

public static final BiquadFilter.Kind BandStop

Band-stop filter (rejects a frequency band).

Method Details

values

public static BiquadFilter.Kind[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static BiquadFilter.Kind valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null