PredefinedFrameType (patrimoine de base SIRIUS 4.16 API)

java.lang.Object
- java.lang.Enum<PredefinedFrameType>
- - fr.cnes.sirius.patrius.frames.PredefinedFrameType

All Implemented Interfaces:

Serializable, Comparable<PredefinedFrameType>
```
public enum PredefinedFrameType
extends Enum<PredefinedFrameType>
```
Predefined frames provided by FramesFactory.

Author:

Luc Maisonobe

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CIRF` CIRF frame.
`ECLIPTIC_J2000` ECLIPTIC J2000
`ECLIPTIC_MOD_WITH_EOP_CORRECTIONS` ECLIPTIC_MOD with EOP corrections.
`ECLIPTIC_MOD_WITHOUT_EOP_CORRECTIONS` ECLIPTIC_MOD without EOP corrections.
`EMB` Earth-Moon barycenter frame.
`EME2000` EME2000 frame.
`G50` G50 (= Gamma 50).
`GCRF` GCRF frame.
`GTOD_WITH_EOP_CORRECTIONS` GTOD with EOP corrections.
`GTOD_WITHOUT_EOP_CORRECTIONS` GTOD without EOP corrections.
`ICRF` ICRF frame.
`ITRF` ITRF.
`ITRF_EQUINOX` Equinox-based ITRF.
`MOD_WITH_EOP_CORRECTIONS` MOD with EOP corrections.
`MOD_WITHOUT_EOP_CORRECTIONS` MOD without EOP corrections.
`TEME` TEME frame.
`TIRF` TIRF.
`TOD_WITH_EOP_CORRECTIONS` TOD with EOP corrections.
`TOD_WITHOUT_EOP_CORRECTIONS` TOD without EOP corrections.
`VEIS_1950` Veis 1950 with tidal effects.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CelestialPoint`	`getCelestialPoint()` Returns the celestial point associated to Predefined frame key.
`String`	`getName()` Get the name of the frame.
`static PredefinedFrameType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static PredefinedFrameType[]`	`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
  - GCRF
```
public static final PredefinedFrameType GCRF
```
    GCRF frame.
  - EMB
```
public static final PredefinedFrameType EMB
```
    Earth-Moon barycenter frame.
  - ICRF
```
public static final PredefinedFrameType ICRF
```
    ICRF frame.
  - EME2000
```
public static final PredefinedFrameType EME2000
```
    EME2000 frame.
  - ITRF
```
public static final PredefinedFrameType ITRF
```
    ITRF.
  - ITRF_EQUINOX
```
public static final PredefinedFrameType ITRF_EQUINOX
```
    Equinox-based ITRF.
  - TIRF
```
public static final PredefinedFrameType TIRF
```
    TIRF.
  - CIRF
```
public static final PredefinedFrameType CIRF
```
    CIRF frame.
  - VEIS_1950
```
public static final PredefinedFrameType VEIS_1950
```
    Veis 1950 with tidal effects.
  - G50
```
public static final PredefinedFrameType G50
```
    G50 (= Gamma 50).
  - GTOD_WITHOUT_EOP_CORRECTIONS
```
public static final PredefinedFrameType GTOD_WITHOUT_EOP_CORRECTIONS
```
    GTOD without EOP corrections.
  - GTOD_WITH_EOP_CORRECTIONS
```
public static final PredefinedFrameType GTOD_WITH_EOP_CORRECTIONS
```
    GTOD with EOP corrections.
  - TOD_WITHOUT_EOP_CORRECTIONS
```
public static final PredefinedFrameType TOD_WITHOUT_EOP_CORRECTIONS
```
    TOD without EOP corrections.
  - TOD_WITH_EOP_CORRECTIONS
```
public static final PredefinedFrameType TOD_WITH_EOP_CORRECTIONS
```
    TOD with EOP corrections.
  - MOD_WITHOUT_EOP_CORRECTIONS
```
public static final PredefinedFrameType MOD_WITHOUT_EOP_CORRECTIONS
```
    MOD without EOP corrections.
  - MOD_WITH_EOP_CORRECTIONS
```
public static final PredefinedFrameType MOD_WITH_EOP_CORRECTIONS
```
    MOD with EOP corrections.
  - TEME
```
public static final PredefinedFrameType TEME
```
    TEME frame.
  - ECLIPTIC_MOD_WITHOUT_EOP_CORRECTIONS
```
public static final PredefinedFrameType ECLIPTIC_MOD_WITHOUT_EOP_CORRECTIONS
```
    ECLIPTIC_MOD without EOP corrections.
  - ECLIPTIC_MOD_WITH_EOP_CORRECTIONS
```
public static final PredefinedFrameType ECLIPTIC_MOD_WITH_EOP_CORRECTIONS
```
    ECLIPTIC_MOD with EOP corrections.
  - ECLIPTIC_J2000
```
public static final PredefinedFrameType ECLIPTIC_J2000
```
    ECLIPTIC J2000
- Method Detail
  - values
```
public static PredefinedFrameType[] 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 (PredefinedFrameType c : PredefinedFrameType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PredefinedFrameType 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
  - getName
```
public String getName()
```
    Get the name of the frame.
    
    Returns:
    
    name of the frame
  - getCelestialPoint
```
public CelestialPoint getCelestialPoint()
                                 throws PatriusException
```
    Returns the celestial point associated to Predefined frame key.
    
    Returns:
    
    the celestial point associated to Predefined frame key
    
    Throws:
    
    PatriusException - thrown if celestial point could not be built

Enum PredefinedFrameType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

GCRF

EMB

ICRF

EME2000

ITRF

ITRF_EQUINOX

TIRF

CIRF

VEIS_1950

G50

GTOD_WITHOUT_EOP_CORRECTIONS

GTOD_WITH_EOP_CORRECTIONS

TOD_WITHOUT_EOP_CORRECTIONS

TOD_WITH_EOP_CORRECTIONS

MOD_WITHOUT_EOP_CORRECTIONS

MOD_WITH_EOP_CORRECTIONS

TEME

ECLIPTIC_MOD_WITHOUT_EOP_CORRECTIONS

ECLIPTIC_MOD_WITH_EOP_CORRECTIONS

ECLIPTIC_J2000

Method Detail

values

valueOf

getName

getCelestialPoint