edu.nrao.sss.astronomy
Enum SideBand

java.lang.Object
  java.lang.Enum<SideBand>
      edu.nrao.sss.astronomy.SideBand

All Implemented Interfaces:

Serializable, Comparable<SideBand>

public enum SideBand
extends Enum<SideBand>

A single sideband of an amplitude modulated signal.

Version Info:

$Revision: 771 $

$Date: 2007-07-19 09:33:08 -0600 (Thu, 19 Jul 2007) $

$Author: dharland $ (last person to modify)

Since:

2007-07-19

Author:

David M. Harland

Enum Constant Summary

LOWER

UPPER

Method Summary

static SideBand	fromString(String text) Returns the side band represented by text.
static SideBand	getDefault() Returns a default side band.
String	toString() Returns a text representation of this enumeration constant.
static SideBand	valueOf(String name) Returns the enum constant of this type with the specified name.
static SideBand[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LOWER

public static final SideBand LOWER

UPPER

public static final SideBand UPPER

Method Detail

values

public static SideBand[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SideBand c : SideBand.values())
    System.out.println(c);

Returns:

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

valueOf

public static SideBand valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getDefault

public static SideBand getDefault()

Returns a default side band.

Returns:

a default side band.

toString

public String toString()

Returns a text representation of this enumeration constant.

Overrides:

toString in class Enum<SideBand>

Returns:

a text representation of this enumeration constant.

fromString

public static SideBand fromString(String text)

Returns the side band represented by text.

For details about the transformation, see EnumerationUtility.enumFromString(Class, String).

Parameters:

text - a text representation of a side band.

Returns:

the side band represented by text.