HiRISE

HiRISE.HiPlan.PTF
Enum PtfField

java.lang.Object
  extended by java.lang.Enum<PtfField>
      extended by HiRISE.HiPlan.PTF.PtfField
All Implemented Interfaces:
Serializable, Comparable<PtfField>

public enum PtfField
extends Enum<PtfField>

An enumeration of the fields of a PTF record. The enumeration identifiers are taken from the PTF software interface specification (SIS).

Each element of the enumeration includes a field number and a set of aliases for the field name. Use the of(String) and of(int) methods to get an element of this enumeration from a piece of text or a field number.

Version:
1.5
Author:
Christian Schaller - UA/PIRL
See Also:
"Payload Target File and Integrated Payload Target File Software Interface Specification (JPL MRO SEQ032)"

Enum Constant Summary
ANCILLARY_DATA
          The ancillary data field.
COMMENT
          The comment field.
COMPRESSION
          The compression field.
COORDINATED_TRACK_HISTORY
          The coordinated track history field.
DOWNLINK_PRIORITY
          The downlink priority field.
ELEVATION
          The observation center elevation field.
INSTRUMENT_SET
          The instrument set field.
INSTRUMENT_SPARE_FIELD_1
          The instrument spare 1 field.
INSTRUMENT_SPARE_FIELD_2
          The instrument spare 2 field.
INSTRUMENT_SPARE_FIELD_3
          The instrument spare 3 field.
INSTRUMENT_SPARE_FIELD_4
          The instrument spare 4 field.
LATITUDE
          The observation center latitude field.
LINE_NUMBER
          The line number field.
LONGITUDE
          The observation center longitude field.
LSUBS
          The solar longitude (Ls) field.
OBSERVATION_DURATION
          The observation duration field.
OBSERVATION_MODE
          The observation mode field.
OBSERVATION_TYPE
          The observation type field.
ORBIT_ALTERNATIVES
          The orbit alternatives field.
ORBIT_NUMBER
          The orbit number field.
ORBITAL_DATA_TABLE
          The orbital data table field.
PARAMETERS_TABLE
          The parameters table field.
PIXEL_SCALE
          The pixel scale field.
PREDICT_TIME
          The observation center predict time field.
PRODUCT_ID
          The product ID field.
RAW_DATA_VOLUME
          The raw data volume field.
REQUEST_CATEGORY
          The request category field.
REQUEST_PRIORITY
          The request priority field.
ROLL_ANGLE
          The roll angle field.
SEQUENCE_FILENAME
          The sequence filename field.
SETUP_DURATION
          The setup duration field.
TEAM_DATABASE_ID
          The team database ID field.
 
Method Summary
 String[] getAliases()
          Gets the enumeration constant's list of aliases.
 int getFieldNumber()
          Gets the enumeration constant's field number.
static boolean isValidFieldNumber(int value)
          Tests whether the input value is a valid PTF field number.
static void main(String... args)
          Invokes a trivial example application to demonstrate the enum constant parsing.
static PtfField of(int fieldNumber)
          Returns the enum constant of this type with the specified filed number.
static PtfField of(String text)
          Returns the enum constant of this type with the specified name, field number, or alias.
static PtfField valueOf(String name)
          Returns the enum constant of this type with the specified name.
static PtfField[] 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, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

LINE_NUMBER

public static final PtfField LINE_NUMBER
The line number field. This is not actually a PTF field, but it is included for applications that include line number with a PTF record. For example, a table model may include a line number.


INSTRUMENT_SET

public static final PtfField INSTRUMENT_SET
The instrument set field. See the PTF SIS for details.


PREDICT_TIME

public static final PtfField PREDICT_TIME
The observation center predict time field. See the PTF SIS for details.


LATITUDE

public static final PtfField LATITUDE
The observation center latitude field. Latitude is in the planetographic coordinate system. See the PTF SIS for details.


LONGITUDE

public static final PtfField LONGITUDE
The observation center longitude field. Longitude is in the planetographic coordinate system. See the PTF SIS for details.


ELEVATION

public static final PtfField ELEVATION
The observation center elevation field. Elevation is measured relative to the MRO reference Mars ellipsoid. See the PTF SIS for details.


OBSERVATION_TYPE

public static final PtfField OBSERVATION_TYPE
The observation type field. Observation type includes relative roll size and spacecraft stability mode. See the PTF SIS for details.


ORBIT_NUMBER

public static final PtfField ORBIT_NUMBER
The orbit number field. See the PTF SIS for details.


ORBIT_ALTERNATIVES

public static final PtfField ORBIT_ALTERNATIVES
The orbit alternatives field. See the PTF SIS for details.


OBSERVATION_DURATION

public static final PtfField OBSERVATION_DURATION
The observation duration field. See the PTF SIS for details.


SETUP_DURATION

public static final PtfField SETUP_DURATION
The setup duration field. See the PTF SIS for details.


ORBITAL_DATA_TABLE

public static final PtfField ORBITAL_DATA_TABLE
The orbital data table field. See the PTF SIS for details; this field is not used by HiRISE.


PARAMETERS_TABLE

public static final PtfField PARAMETERS_TABLE
The parameters table field. See the PTF SIS for details; this field is not used by HiRISE.


SEQUENCE_FILENAME

public static final PtfField SEQUENCE_FILENAME
The sequence filename field. See the PTF SIS for details.


DOWNLINK_PRIORITY

public static final PtfField DOWNLINK_PRIORITY
The downlink priority field. See the PTF SIS for details.


PRODUCT_ID

public static final PtfField PRODUCT_ID
The product ID field. See the PTF SIS for details; this field is not used by HiRISE.


INSTRUMENT_SPARE_FIELD_1

public static final PtfField INSTRUMENT_SPARE_FIELD_1
The instrument spare 1 field. See the PTF SIS for details.


INSTRUMENT_SPARE_FIELD_2

public static final PtfField INSTRUMENT_SPARE_FIELD_2
The instrument spare 2 field. See the PTF SIS for details.


INSTRUMENT_SPARE_FIELD_3

public static final PtfField INSTRUMENT_SPARE_FIELD_3
The instrument spare 3 field. See the PTF SIS for details.


INSTRUMENT_SPARE_FIELD_4

public static final PtfField INSTRUMENT_SPARE_FIELD_4
The instrument spare 4 field. See the PTF SIS for details.


COMMENT

public static final PtfField COMMENT
The comment field. See the PTF SIS for details.


REQUEST_PRIORITY

public static final PtfField REQUEST_PRIORITY
The request priority field. See the PTF SIS for details.


COORDINATED_TRACK_HISTORY

public static final PtfField COORDINATED_TRACK_HISTORY
The coordinated track history field. See the PTF SIS for details.


RAW_DATA_VOLUME

public static final PtfField RAW_DATA_VOLUME
The raw data volume field. See the PTF SIS for details.


TEAM_DATABASE_ID

public static final PtfField TEAM_DATABASE_ID
The team database ID field. See the PTF SIS for details.


REQUEST_CATEGORY

public static final PtfField REQUEST_CATEGORY
The request category field. See the PTF SIS for details.


COMPRESSION

public static final PtfField COMPRESSION
The compression field. See the PTF SIS for details.


PIXEL_SCALE

public static final PtfField PIXEL_SCALE
The pixel scale field. See the PTF SIS for details.


OBSERVATION_MODE

public static final PtfField OBSERVATION_MODE
The observation mode field. See the PTF SIS for details.


ANCILLARY_DATA

public static final PtfField ANCILLARY_DATA
The ancillary data field. See the PTF SIS for details; HiRISE uses this field to indicate participation in a stereo pair.


LSUBS

public static final PtfField LSUBS
The solar longitude (Ls) field. See the PTF SIS for details.


ROLL_ANGLE

public static final PtfField ROLL_ANGLE
The roll angle field. See the PTF SIS for details.

Method Detail

values

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

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

valueOf

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

getFieldNumber

public int getFieldNumber()
Gets the enumeration constant's field number.

Returns:
the field number.

getAliases

public String[] getAliases()
Gets the enumeration constant's list of aliases. May be an empty array; will not be null.

Returns:
the list of aliases, which may be an empty array.

of

public static PtfField of(String text)
Returns the enum constant of this type with the specified name, field number, or alias. The tests are case-insensitive, leading and trailing spaces are removed, and spaces and dashes are converted to underscores for the tests. That is, the following invocations return the same value, PREDICT_TIME:
    PtfField.of("predict-time")
    PtfField.of("PREDICT TIME")
    PtfField.of("    Predict_Time    ")
    PtfField.of("2")

If text is null, a NullPointerException is thrown. If text cannot be interpreted as an enum constant name, field number, or alias, an IllegalArgumentException is thrown.

Parameters:
text - the text used to identify the enum constant.
Returns:
the enum constant with the specified name, field number, or alias.
See Also:
getFieldNumber(), getAliases(), isValidFieldNumber(int), of(int)

of

public static PtfField of(int fieldNumber)
Returns the enum constant of this type with the specified filed number. If the field number does not match a PTF field, an IllegalArgumentException is thrown.

Parameters:
fieldNumber - the field number used to identify the enum constant.
Returns:
the enum constant with the specified field number.
See Also:
getFieldNumber(), isValidFieldNumber(int)

isValidFieldNumber

public static boolean isValidFieldNumber(int value)
Tests whether the input value is a valid PTF field number. PTF field numbers can be in the range 0 through 31.

Parameters:
value - the value to test.
Returns:
true if a valid PTF field value; false otherwise.

main

public static void main(String... args)
Invokes a trivial example application to demonstrate the enum constant parsing. Input arguments are passed to of(String) to get an enum constant; if no match is found, that fact is reported. Results are printed to the standard output stream.

The test application also prints a complete list of all enum constants of this type, their field number, and their aliases, if any.

Parameters:
args - the input values to be used to identify enum constants.

HiRISE

Copyright (C) Arizona Board of Regents on behalf of the Planetary Image Research Laboratory, Lunar and Planetary Laboratory at the University of Arizona