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

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

All Implemented Interfaces:

Serializable, Comparable<AntennaWrap>

public enum AntennaWrap
extends Enum<AntennaWrap>

A representation of the "wrapping" of an antenna.

As an example, the VLA antennas can rotate 540 degrees in azimuth. An observer can request that an observation be set up so that it has the least likelihood to run into one of the stops. The observer does this by specifying that the wrap be either clockwise or counterclockwise.

CVS Info:

$Revision: 161 $

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

$Author: btruitt $

Since:

2006-07-14

Author:

David M. Harland

Enum Constant Summary

CLOCKWISE

COUNTERCLOCKWISE

NO_PREFERENCE

Method Summary

static AntennaWrap	fromString(String text) Returns the antenna wrap represented by text.
static AntennaWrap	getDefault() Returns a default antenna wrap.
String	toString() Returns a text representation of this enumeration constant.
static AntennaWrap	valueOf(String name) Returns the enum constant of this type with the specified name.
static AntennaWrap[]	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

CLOCKWISE

public static final AntennaWrap CLOCKWISE

COUNTERCLOCKWISE

public static final AntennaWrap COUNTERCLOCKWISE

NO_PREFERENCE

public static final AntennaWrap NO_PREFERENCE

Method Detail

values

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

Returns:

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

valueOf

public static AntennaWrap 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 AntennaWrap getDefault()

Returns a default antenna wrap.

Returns:

a default antenna wrap.

toString

public String toString()

Returns a text representation of this enumeration constant.

Overrides:

toString in class Enum<AntennaWrap>

Returns:

a text representation of this enumeration constant.

fromString

public static AntennaWrap fromString(String text)

Returns the antenna wrap represented by text.

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

Parameters:

text - a text representation of an antenna wrap.

Returns:

the antenna wrap represented by text.