edu.nrao.sss.astronomy
Enum SkyPositionType

java.lang.Object
  java.lang.Enum<SkyPositionType>
      edu.nrao.sss.astronomy.SkyPositionType

All Implemented Interfaces:

Serializable, Comparable<SkyPositionType>

public enum SkyPositionType
extends Enum<SkyPositionType>

An indicator for the form in which position information is held.

Version Info:

$Revision: 550 $

$Date: 2007-04-22 12:25:08 -0600 (Sun, 22 Apr 2007) $

$Author: dharland $

Since:

2007-04-18

Author:

David M. Harland

Enum Constant Summary

EPHEMERIS_TABLE
Position information stored as an ephemeris table.

INTERNAL_EPHEMERIS
Position information stored as the name of a body that can later be turned into an ephemeris table.

ORBITAL_ELEMENTS
Position information stored as orbital elements.

POLYNOMIAL
Position information stored as a single polynomial equation.

POLYNOMIAL_TABLE
Position information stored as a series of one or more polynomial equations where the independent variable is time.

SIMPLE
The simplest form of position information.

Method Summary

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

SIMPLE

public static final SkyPositionType SIMPLE

The simplest form of position information. This typically means that the position is not stored as a function of time.

POLYNOMIAL

public static final SkyPositionType POLYNOMIAL

Position information stored as a single polynomial equation. equations where the independent variable is time.

POLYNOMIAL_TABLE

public static final SkyPositionType POLYNOMIAL_TABLE

Position information stored as a series of one or more polynomial equations where the independent variable is time.

ORBITAL_ELEMENTS

public static final SkyPositionType ORBITAL_ELEMENTS

Position information stored as orbital elements.

EPHEMERIS_TABLE

public static final SkyPositionType EPHEMERIS_TABLE

Position information stored as an ephemeris table.

INTERNAL_EPHEMERIS

public static final SkyPositionType INTERNAL_EPHEMERIS

Position information stored as the name of a body that can later be turned into an ephemeris table.

Method Detail

values

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

Returns:

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

valueOf

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

Returns a default source position type.

Returns:

a default source position type.

toString

public String toString()

Returns a text representation of this enumeration constant.

Overrides:

toString in class Enum<SkyPositionType>

Returns:

a text representation of this enumeration constant.

fromString

public static SkyPositionType fromString(String text)

Returns the source position type represented by text.

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

Parameters:

text - a text representation of a source position type.

Returns:

the source position type represented by text.