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

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

All Implemented Interfaces:

Serializable, Comparable<ScanMode>

public enum ScanMode
extends Enum<ScanMode>

An enumeration of the kinds of observations that may be performed on a source.

Version Info:

$Revision: 2150 $

$Date: 2009-04-02 16:27:10 -0600 (Thu, 02 Apr 2009) $

$Author: dharland $

Since:

2006-03-24

Author:

David M. Harland

Enum Constant Summary

AMPLITUDE_DELAY_CALIBRATING

FAST_SWITCHING

HOLOGRAPHY

INTERFEROMETRIC_POINTING

MOSAICKING

REFERENCE_FOCUSING

SINGLE_DISH_POINTING

STANDARD_OBSERVING

TIPPING

Method Summary

static ScanMode	fromString(String text) Returns the scan mode represented by text.
String	getAbbreviation()
static ScanMode	getDefault() Returns the scan mode to use as a default.
Set<ScanIntent>	getValidIntents() Returns a set of intents that are valid for this scan mode.
String	toString() Returns a text representation of this enumeration constant.
static ScanMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ScanMode[]	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

STANDARD_OBSERVING

public static final ScanMode STANDARD_OBSERVING

INTERFEROMETRIC_POINTING

public static final ScanMode INTERFEROMETRIC_POINTING

SINGLE_DISH_POINTING

public static final ScanMode SINGLE_DISH_POINTING

REFERENCE_FOCUSING

public static final ScanMode REFERENCE_FOCUSING

AMPLITUDE_DELAY_CALIBRATING

public static final ScanMode AMPLITUDE_DELAY_CALIBRATING

TIPPING

public static final ScanMode TIPPING

HOLOGRAPHY

public static final ScanMode HOLOGRAPHY

MOSAICKING

public static final ScanMode MOSAICKING

FAST_SWITCHING

public static final ScanMode FAST_SWITCHING

Method Detail

values

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

Returns:

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

valueOf

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

getValidIntents

public Set<ScanIntent> getValidIntents()

Returns a set of intents that are valid for this scan mode.

Returns:

a set of intents that are valid for this scan mode.

getDefault

public static ScanMode getDefault()

Returns the scan mode to use as a default.

Returns:

a default scan mode.

getAbbreviation

public String getAbbreviation()

Returns:

a short abbreviation of this scan mode. XXX Here to help generate a short display label for a scan.

toString

public String toString()

Returns a text representation of this enumeration constant.

Overrides:

toString in class Enum<ScanMode>

Returns:

a text representation of this enumeration constant.

fromString

public static ScanMode fromString(String text)

Returns the scan mode represented by text.

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

Parameters:

text - a text representation of a scan mode.

Returns:

the scan mode represented by text.