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

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

All Implemented Interfaces:

Serializable, Comparable<ScanIntent>

public enum ScanIntent
extends Enum<ScanIntent>

An enumeration of the reasons for which a scan is made.

Version Info:

$Revision: 1646 $

$Date: 2008-10-27 13:55:18 -0600 (Mon, 27 Oct 2008) $

$Author: dharland $

Since:

2006-07-10

Author:

David M. Harland

Enum Constant Summary

CALIBRATE_ABSOLUTE_POSITION

CALIBRATE_BANDPASS

CALIBRATE_COMPLEX_GAIN

CALIBRATE_DELAY_AMPLITUDE_STYLE

CALIBRATE_DELAY_PHASE_STYLE

CALIBRATE_FLUX_DENSITY_SCALE

CALIBRATE_FOCUS

CALIBRATE_OFFSET_POINTING

CALIBRATE_POLARIZATION_ANGLE

CALIBRATE_POLARIZATION_LEAKAGE

DETERMINE_ANTENNA_GLOBAL_POINTING_MODEL

DETERMINE_AUTOPHASE

DETERMINE_OPACITY_TIPPING_STYLE

DETERMINE_RFI

DETERMINE_SINGLE_DISH_POINTING

MAP_ANTENNA_SURFACE

OBSERVE_PULSAR

OBSERVE_TARGET

OTHER

TIME_PULSAR

Method Summary

static ScanIntent	fromString(String text) Returns the scan intent represented by text.
String	getAbbreviation() Returns a short version of this intent's name.
static ScanIntent	getDefault() Returns a default scan intent.
String	getSdmText() Returns a valid Science Data Model (SDM) string for this intent.
String	toString() Returns a text representation of this enumeration constant.
static ScanIntent	valueOf(String name) Returns the enum constant of this type with the specified name.
static ScanIntent[]	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

OBSERVE_TARGET

public static final ScanIntent OBSERVE_TARGET

CALIBRATE_BANDPASS

public static final ScanIntent CALIBRATE_BANDPASS

CALIBRATE_FLUX_DENSITY_SCALE

public static final ScanIntent CALIBRATE_FLUX_DENSITY_SCALE

CALIBRATE_COMPLEX_GAIN

public static final ScanIntent CALIBRATE_COMPLEX_GAIN

CALIBRATE_POLARIZATION_ANGLE

public static final ScanIntent CALIBRATE_POLARIZATION_ANGLE

CALIBRATE_POLARIZATION_LEAKAGE

public static final ScanIntent CALIBRATE_POLARIZATION_LEAKAGE

CALIBRATE_ABSOLUTE_POSITION

public static final ScanIntent CALIBRATE_ABSOLUTE_POSITION

CALIBRATE_OFFSET_POINTING

public static final ScanIntent CALIBRATE_OFFSET_POINTING

DETERMINE_AUTOPHASE

public static final ScanIntent DETERMINE_AUTOPHASE

DETERMINE_RFI

public static final ScanIntent DETERMINE_RFI

CALIBRATE_DELAY_AMPLITUDE_STYLE

public static final ScanIntent CALIBRATE_DELAY_AMPLITUDE_STYLE

CALIBRATE_DELAY_PHASE_STYLE

public static final ScanIntent CALIBRATE_DELAY_PHASE_STYLE

DETERMINE_ANTENNA_GLOBAL_POINTING_MODEL

public static final ScanIntent DETERMINE_ANTENNA_GLOBAL_POINTING_MODEL

MAP_ANTENNA_SURFACE

public static final ScanIntent MAP_ANTENNA_SURFACE

CALIBRATE_FOCUS

public static final ScanIntent CALIBRATE_FOCUS

DETERMINE_SINGLE_DISH_POINTING

public static final ScanIntent DETERMINE_SINGLE_DISH_POINTING

DETERMINE_OPACITY_TIPPING_STYLE

public static final ScanIntent DETERMINE_OPACITY_TIPPING_STYLE

OBSERVE_PULSAR

public static final ScanIntent OBSERVE_PULSAR

TIME_PULSAR

public static final ScanIntent TIME_PULSAR

OTHER

public static final ScanIntent OTHER

Method Detail

values

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

Returns:

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

valueOf

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

Returns a default scan intent.

Returns:

a default scan intent.

getAbbreviation

public String getAbbreviation()

Returns a short version of this intent's name.

Returns:

a short version of this intent's name.

getSdmText

public String getSdmText()

Returns a valid Science Data Model (SDM) string for this intent.

Returns:

a valid Science Data Model (SDM) string for this intent.

toString

public String toString()

Returns a text representation of this enumeration constant.

Overrides:

toString in class Enum<ScanIntent>

Returns:

a text representation of this enumeration constant.

fromString

public static ScanIntent fromString(String text)

Returns the scan intent represented by text.

For details about the transformation, see EnumerationUtility.enumFromString(Class, String). In addition to using the name and toString methods, the abbreviations of the intents are also used in the search for a matching intent.

Parameters:

text - a text representation of a scan intent.

Returns:

the scan intent represented by text.