Predefined (patrius 4.0 API)

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

All Implemented Interfaces:

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

Author:

Luc Maisonobe

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CIRF` CIRF frame.
`EME2000` EME2000 frame.
`EOD_WITH_EOP_CORRECTIONS` EOD with EOP corrections.
`EOD_WITHOUT_EOP_CORRECTIONS` EOD without EOP corrections.
`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

Methods
Modifier and Type	Method and Description
`String`	`getName()` Get the name of the frame.
`static Predefined`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Predefined[]`	`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 Predefined GCRF
```
    GCRF frame.
  - ICRF
```
public static final Predefined ICRF
```
    ICRF frame.
  - EME2000
```
public static final Predefined EME2000
```
    EME2000 frame.
  - ITRF
```
public static final Predefined ITRF
```
    ITRF.
  - ITRF_EQUINOX
```
public static final Predefined ITRF_EQUINOX
```
    Equinox-based ITRF.
  - TIRF
```
public static final Predefined TIRF
```
    TIRF.
  - CIRF
```
public static final Predefined CIRF
```
    CIRF frame.
  - VEIS_1950
```
public static final Predefined VEIS_1950
```
    Veis 1950 with tidal effects.
  - GTOD_WITHOUT_EOP_CORRECTIONS
```
public static final Predefined GTOD_WITHOUT_EOP_CORRECTIONS
```
    GTOD without EOP corrections.
  - GTOD_WITH_EOP_CORRECTIONS
```
public static final Predefined GTOD_WITH_EOP_CORRECTIONS
```
    GTOD with EOP corrections.
  - TOD_WITHOUT_EOP_CORRECTIONS
```
public static final Predefined TOD_WITHOUT_EOP_CORRECTIONS
```
    TOD without EOP corrections.
  - TOD_WITH_EOP_CORRECTIONS
```
public static final Predefined TOD_WITH_EOP_CORRECTIONS
```
    TOD with EOP corrections.
  - MOD_WITHOUT_EOP_CORRECTIONS
```
public static final Predefined MOD_WITHOUT_EOP_CORRECTIONS
```
    MOD without EOP corrections.
  - MOD_WITH_EOP_CORRECTIONS
```
public static final Predefined MOD_WITH_EOP_CORRECTIONS
```
    MOD with EOP corrections.
  - TEME
```
public static final Predefined TEME
```
    TEME frame.
  - EOD_WITHOUT_EOP_CORRECTIONS
```
public static final Predefined EOD_WITHOUT_EOP_CORRECTIONS
```
    EOD without EOP corrections.
  - EOD_WITH_EOP_CORRECTIONS
```
public static final Predefined EOD_WITH_EOP_CORRECTIONS
```
    EOD with EOP corrections.
- Method Detail
  - values
```
public static Predefined[] 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 (Predefined c : Predefined.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Predefined 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

Enum Predefined

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

GCRF

ICRF

EME2000

ITRF

ITRF_EQUINOX

TIRF

CIRF

VEIS_1950

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

EOD_WITHOUT_EOP_CORRECTIONS

EOD_WITH_EOP_CORRECTIONS

Method Detail

values

valueOf

getName