edu.nrao.sss.model.project.scan
Enum TippingOrder

java.lang.Object
  java.lang.Enum<TippingOrder>
      edu.nrao.sss.model.project.scan.TippingOrder

All Implemented Interfaces:

Serializable, Comparable<TippingOrder>

public enum TippingOrder
extends Enum<TippingOrder>

The direction in which to tip an antenna.

CVS Info:

$Revision: 161 $

$Date: 2006-12-15 11:48:34 -0700 (Fri, 15 Dec 2006) $

$Author: btruitt $

Since:

2006-07-18

Author:

David M. Harland

Enum Constant Summary

HIGH_TO_LOW
Tip the antenna from the highest elevation to the lowest.

LOW_TO_HIGH
Tip the antenna from the lowest elevation to the highest.

Method Summary

static TippingOrder	fromString(String text) Returns the tipping order represented by text.
static TippingOrder	getDefault() Returns the default tipping direction.
TippingOrder	getReverseOrder() Returns the tipping order that represents the reverse direction from this one.
String	toString() Returns a text representation of this enumeration constant.
static TippingOrder	valueOf(String name) Returns the enum constant of this type with the specified name.
static TippingOrder[]	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

LOW_TO_HIGH

public static final TippingOrder LOW_TO_HIGH

Tip the antenna from the lowest elevation to the highest.

HIGH_TO_LOW

public static final TippingOrder HIGH_TO_LOW

Tip the antenna from the highest elevation to the lowest.

Method Detail

values

public static TippingOrder[] 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 (TippingOrder c : TippingOrder.values())
    System.out.println(c);

Returns:

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

valueOf

public static TippingOrder 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

getReverseOrder

public TippingOrder getReverseOrder()

Returns the tipping order that represents the reverse direction from this one.

Returns:

the reverse tipping order.

getDefault

public static TippingOrder getDefault()

Returns the default tipping direction.

Returns:

the default tipping direction.

toString

public String toString()

Returns a text representation of this enumeration constant.

Overrides:

toString in class Enum<TippingOrder>

Returns:

a text representation of this enumeration constant.

fromString

public static TippingOrder fromString(String text)

Returns the tipping order represented by text.

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

Parameters:

text - a text representation of a tipping order.

Returns:

the tipping order represented by text.