HiRISE.HiPlan.PTF

Enum FindOrbits.SortField

java.lang.Object

java.lang.Enum<FindOrbits.SortField>

HiRISE.HiPlan.PTF.FindOrbits.SortField

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FindOrbits.SortField>

Enclosing class:

FindOrbits

public static enum FindOrbits.SortField
extends java.lang.Enum<FindOrbits.SortField>

An enumeration of fields for sorting resolved geometries.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INCIDENCE Incidence angle.
PASS Orbit pass.
PREDICT_TIME Predict time.
ROLL Roll angle.
SPLIT_ROLL Roll-angle sorting with angles between 4 and 9 degrees sorted ahead of other values.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAbbreviation()
static FindOrbits.SortField	of(java.lang.String alias) Gets a sort field enumeration value given a text string.
static FindOrbits.SortField	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FindOrbits.SortField[]	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

ROLL

public static final FindOrbits.SortField ROLL

Roll angle. Note that roll-angle sorting is done with the absolute values of the roll angles.

SPLIT_ROLL

public static final FindOrbits.SortField SPLIT_ROLL

Roll-angle sorting with angles between 4 and 9 degrees sorted ahead of other values. Note that roll-angle sorting is done with the absolute values of the roll angles.

Example: With split-roll sorting, the roll angles 28.8, -1.3, 4.6, 3.7, -8.7, and 14.2 are sorted to 4.6, -8.7, -1.3, 3.7, 14.2, 28.8.

PASS

public static final FindOrbits.SortField PASS

Orbit pass.

INCIDENCE

public static final FindOrbits.SortField INCIDENCE

Incidence angle.

PREDICT_TIME

public static final FindOrbits.SortField PREDICT_TIME

Predict time.

Method Detail

values

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

Returns:

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

valueOf

public static FindOrbits.SortField valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

of

public static FindOrbits.SortField of(java.lang.String alias)
                               throws java.lang.IllegalArgumentException

Gets a sort field enumeration value given a text string.

Parameters:

alias - the text string, which may be an alias for the field name.

Returns:

the sort field.

Throws:

java.lang.IllegalArgumentException - if no sort field can be deduced from the alias.

getAbbreviation

public java.lang.String getAbbreviation()