Package org.javastro.ivoa.entities.resource.ssap

Enum Class SupportedFrame

java.lang.Object

java.lang.Enum<SupportedFrame>

org.javastro.ivoa.entities.resource.ssap.SupportedFrame

All Implemented Interfaces:

Serializable, Comparable<SupportedFrame>, Constable, org.jvnet.jaxb.lang.EnumValue<String>

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public enum SupportedFrame
extends Enum<SupportedFrame>
implements org.jvnet.jaxb.lang.EnumValue<String>

A controlled list of space-time reference frame names defined from Table 3 (S 4.4.1.2.3) of the STC spec.

Java class for SupportedFrame

.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="SupportedFrame">
   <restriction base="{http://www.w3.org/2001/XMLSchema}token">
     <enumeration value="FK4"/>
     <enumeration value="FK5"/>
     <enumeration value="ECLIPTIC"/>
     <enumeration value="ICRS"/>
     <enumeration value="GALACTIC_I"/>
     <enumeration value="GALACTIC_II"/>
     <enumeration value="SUPER_GALACTIC"/>
     <enumeration value="AZ_EL"/>
     <enumeration value="BODY"/>
     <enumeration value="GEO_C"/>
     <enumeration value="GEO_D"/>
     <enumeration value="MAG"/>
     <enumeration value="GSE"/>
     <enumeration value="GSM"/>
     <enumeration value="HGC"/>
     <enumeration value="HGS"/>
     <enumeration value="HEEQ"/>
     <enumeration value="HRTN"/>
     <enumeration value="HPC"/>
     <enumeration value="HPR"/>
     <enumeration value="HCC"/>
     <enumeration value="HGI"/>
     <enumeration value="MERCURY_C"/>
     <enumeration value="VENUS_C"/>
     <enumeration value="LUNA_C"/>
     <enumeration value="MARS_C"/>
     <enumeration value="JUPITER_C_III"/>
     <enumeration value="SATURN_C_III"/>
     <enumeration value="URANUS_C_III"/>
     <enumeration value="NEPTUNE_C_III"/>
     <enumeration value="PLUTO_C"/>
     <enumeration value="MERCURY_G"/>
     <enumeration value="VENUS_G"/>
     <enumeration value="LUNA_G"/>
     <enumeration value="MARS_G"/>
     <enumeration value="JUPITER_G_III"/>
     <enumeration value="SATURN_G_III"/>
     <enumeration value="URANUS_G_III"/>
     <enumeration value="NEPTUNE_G_III"/>
     <enumeration value="PLUTO_G"/>
     <enumeration value="UNKNOWN"/>
   </restriction>
 </simpleType>
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AZ_EL	The local azimuth and elevation frame where azimuth increases from north through east.
BODY	If applicable, queries against this system should assume a default magnitude value or range in the absence of an applicable (non-standard) query constraint.
ECLIPTIC	Ecliptic coordinates
FK_4	Spectrum data files will require a specification of the equinox; if it is not expressed explicitly, B1950.0 should be assumed.
FK_5	Spectrum data files will require a specification of the equinox; if it is not expressed explicitly, J2000.0 should be assumed.
GALACTIC_I	old Galactic coordinates
GALACTIC_II	old Galactic coordinates
GEO_C	If applicable, queries against this system should assume a default magnitude value or range in the absence of an applicable (non-standard) query constraint.
GEO_D	Semi-major axis and inverse flattening of the reference spheroid may need to be assumed; a default as defined by the IAU 1976 is recommended.
GSE	See Franz and Harper 2002, Planetary and Space Science, vol 50, p.
GSM	See Franz and Harper 2002, Planetary and Space Science, vol 50, p.
HCC	See Thompson 2006, "Coordinate Systems for Solar Image Data", A&A., Section 2.1
HEEQ	See Franz and Harper 2002, Planetary and Space Science, vol 50, p.
HGC	See Thompson 2006, "Coordinate Systems for Solar Image Data", A&A., Section 2.2
HGI	See Franz and Harper 2002, Planetary and Space Science, vol 50, p.
HGS	See Thompson 2006, "Coordinate Systems for Solar Image Data", A&A., Section 2.2
HPC	See Thompson 2006, "Coordinate Systems for Solar Image Data", A&A., Section 2.1
HPR	See Thompson 2006, "Coordinate Systems for Solar Image Data", A&A., Section 2.1
HRTN	See Franz and Harper 2002, Planetary and Space Science, vol 50, p.
ICRS	International Celestial Reference System
JUPITER_C_III	Planteocentric coordinates on Jupiter, system III
JUPITER_G_III	Planteographic coordinates on Jupiter, system III
LUNA_C	Selenocentric coordinates (for the Moon)
LUNA_G	Selenographic coordinates (for the Moon)
MAG	If applicable, queries against this system should assume a default magnitude value or range in the absence of an applicable (non-standard) query constraint.
MARS_C	Planteocentric coordinates on Mars
MARS_G	Planteographic coordinates on Mars
MERCURY_C	Planteocentric coordinates on Mercury
MERCURY_G	Planteographic coordinates on Mercury
NEPTUNE_C_III	Planteocentric coordinates on Neptune, system III
NEPTUNE_G_III	Planteographic coordinates on Neptune, system III
PLUTO_C	Planteocentric coordinates on Mercury
PLUTO_G	Planteographic coordinates on Mercury
SATURN_C_III	Planteocentric coordinates on Saturn, system III
SATURN_G_III	Planteographic coordinates on Saturn, system III
SUPER_GALACTIC	Super-galactic coordinates with the north pole at GALACTIC_II (47.37, +6.32) and the origin at GALACTIC_II (137.37, 0).
UNKNOWN	Any available descriptive details should be given (or referenced) in the capability's description.
URANUS_C_III	Planteocentric coordinates on Uranus, system III
URANUS_G_III	Planteographic coordinates on Uranus, system III
VENUS_C	Planteocentric coordinates on Venus
VENUS_G	Planteographic coordinates on Venus

Method Summary

Modifier and Type	Method	Description
String	enumValue()
static SupportedFrame	fromValue(String v)	Gets the enum associated to the value passed as parameter.
String	value()	Gets the value associated to the enum constant.
static SupportedFrame	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SupportedFrame[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FK_4

public static final SupportedFrame FK_4

Spectrum data files will require a specification of the equinox; if it is not expressed explicitly, B1950.0 should be assumed.

FK_5

public static final SupportedFrame FK_5

Spectrum data files will require a specification of the equinox; if it is not expressed explicitly, J2000.0 should be assumed.

ECLIPTIC

public static final SupportedFrame ECLIPTIC

Ecliptic coordinates

ICRS

public static final SupportedFrame ICRS

International Celestial Reference System

GALACTIC_I

public static final SupportedFrame GALACTIC_I

old Galactic coordinates

GALACTIC_II

public static final SupportedFrame GALACTIC_II

old Galactic coordinates

SUPER_GALACTIC

public static final SupportedFrame SUPER_GALACTIC

Super-galactic coordinates with the north pole at GALACTIC_II (47.37, +6.32) and the origin at GALACTIC_II (137.37, 0).

AZ_EL

public static final SupportedFrame AZ_EL

The local azimuth and elevation frame where azimuth increases from north through east.

BODY

public static final SupportedFrame BODY

If applicable, queries against this system should assume a default magnitude value or range in the absence of an applicable (non-standard) query constraint. Service providers are encouraged to document the such assumptions in the resource or capability description.

GEO_C

public static final SupportedFrame GEO_C

If applicable, queries against this system should assume a default magnitude value or range in the absence of an applicable (non-standard) query constraint. Service providers are encouraged to document the such assumptions in the resource or capability description.

GEO_D

public static final SupportedFrame GEO_D

Semi-major axis and inverse flattening of the reference spheroid may need to be assumed; a default as defined by the IAU 1976 is recommended.

MAG

public static final SupportedFrame MAG

If applicable, queries against this system should assume a default magnitude value or range in the absence of an applicable (non-standard) query constraint. Service providers are encouraged to document the such assumptions in the resource or capability description.

GSE

public static final SupportedFrame GSE

See Franz and Harper 2002, Planetary and Space Science, vol 50, p. 217.

GSM

public static final SupportedFrame GSM

See Franz and Harper 2002, Planetary and Space Science, vol 50, p. 217.

HGC

public static final SupportedFrame HGC

See Thompson 2006, "Coordinate Systems for Solar Image Data", A&A., Section 2.2

HGS

public static final SupportedFrame HGS

See Thompson 2006, "Coordinate Systems for Solar Image Data", A&A., Section 2.2

HEEQ

public static final SupportedFrame HEEQ

See Franz and Harper 2002, Planetary and Space Science, vol 50, p. 217, and Thompson 2006, "Coordinate Systems for Solar Image Data", A&A., Section 2.1

HRTN

public static final SupportedFrame HRTN

See Franz and Harper 2002, Planetary and Space Science, vol 50, p. 217.

HPC

public static final SupportedFrame HPC

See Thompson 2006, "Coordinate Systems for Solar Image Data", A&A., Section 2.1

HPR

public static final SupportedFrame HPR

See Thompson 2006, "Coordinate Systems for Solar Image Data", A&A., Section 2.1

HCC

public static final SupportedFrame HCC

See Thompson 2006, "Coordinate Systems for Solar Image Data", A&A., Section 2.1

HGI

public static final SupportedFrame HGI

See Franz and Harper 2002, Planetary and Space Science, vol 50, p. 217.

MERCURY_C

public static final SupportedFrame MERCURY_C

Planteocentric coordinates on Mercury

VENUS_C

public static final SupportedFrame VENUS_C

Planteocentric coordinates on Venus

LUNA_C

public static final SupportedFrame LUNA_C

Selenocentric coordinates (for the Moon)

MARS_C

public static final SupportedFrame MARS_C

Planteocentric coordinates on Mars

JUPITER_C_III

public static final SupportedFrame JUPITER_C_III

Planteocentric coordinates on Jupiter, system III

SATURN_C_III

public static final SupportedFrame SATURN_C_III

Planteocentric coordinates on Saturn, system III

URANUS_C_III

public static final SupportedFrame URANUS_C_III

Planteocentric coordinates on Uranus, system III

NEPTUNE_C_III

public static final SupportedFrame NEPTUNE_C_III

Planteocentric coordinates on Neptune, system III

PLUTO_C

public static final SupportedFrame PLUTO_C

Planteocentric coordinates on Mercury

MERCURY_G

public static final SupportedFrame MERCURY_G

Planteographic coordinates on Mercury

VENUS_G

public static final SupportedFrame VENUS_G

Planteographic coordinates on Venus

LUNA_G

public static final SupportedFrame LUNA_G

Selenographic coordinates (for the Moon)

MARS_G

public static final SupportedFrame MARS_G

Planteographic coordinates on Mars

JUPITER_G_III

public static final SupportedFrame JUPITER_G_III

Planteographic coordinates on Jupiter, system III

SATURN_G_III

public static final SupportedFrame SATURN_G_III

Planteographic coordinates on Saturn, system III

URANUS_G_III

public static final SupportedFrame URANUS_G_III

Planteographic coordinates on Uranus, system III

NEPTUNE_G_III

public static final SupportedFrame NEPTUNE_G_III

Planteographic coordinates on Neptune, system III

PLUTO_G

public static final SupportedFrame PLUTO_G

Planteographic coordinates on Mercury

UNKNOWN

public static final SupportedFrame UNKNOWN

Any available descriptive details should be given (or referenced) in the capability's description.

Method Details

values

public static SupportedFrame[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SupportedFrame valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

Gets the value associated to the enum constant.

Returns:

The value linked to the enum.

fromValue

public static SupportedFrame fromValue(String v)

Gets the enum associated to the value passed as parameter.

Parameters:

v - The value to get the enum from.

Returns:

The enum which corresponds to the value, if it exists.

Throws:

IllegalArgumentException - If no value matches in the enum declaration.

enumValue

public String enumValue()

Specified by:

enumValue in interface org.jvnet.jaxb.lang.EnumValue<String>