Package llnl.gnem.core.util

Enum Class Passband

java.lang.Object

java.lang.Enum<Passband>

llnl.gnem.core.util.Passband

All Implemented Interfaces:

Serializable, Comparable<Passband>, Constable

public enum Passband
extends Enum<Passband>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BAND_PASS
BAND_REJECT
HIGH_PASS
LOW_PASS

Method Summary

Modifier and Type	Method	Description
static Passband	getPassband(String code)	Returns a Passband object given a 2-character String descriptor.
String	toString()	A string representation of the passband for a filter suitable for use with the ButterworthFilter..
static Passband	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Passband[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BAND_PASS

public static final Passband BAND_PASS

BAND_REJECT

public static final Passband BAND_REJECT

LOW_PASS

public static final Passband LOW_PASS

HIGH_PASS

public static final Passband HIGH_PASS

Method Details

values

public static Passband[] 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 Passband 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

toString

public String toString()

A string representation of the passband for a filter suitable for use with the ButterworthFilter..

Overrides:

toString in class Enum<Passband>

Returns:

A String with the one of the values "LP", or "HP", "BP", "BR"

getPassband

public static Passband getPassband(String code)

Returns a Passband object given a 2-character String descriptor. Only recognized codes are "BP", "LP", "HP", "BR". Any other String will result in a null Passband object.

Parameters:

code - The code of the desired passband object.

Returns:

The specified Passband object.