org.orekit.gnss.antenna

Enum SatelliteType

java.lang.Object

java.lang.Enum<SatelliteType>

org.orekit.gnss.antenna.SatelliteType

All Implemented Interfaces:

Serializable, Comparable<SatelliteType>

public enum SatelliteType
extends Enum<SatelliteType>

Enumerate for satellite types.

Since:

9.3

Author:

Luc Maisonobe

Enum Constant Summary

Enum Constants

Enum Constant and Description
BEIDOU_2G BeiDou-2 GEO.
BEIDOU_2I BeiDou-2 IGSO.
BEIDOU_2M BeiDou-2 MEO.
BEIDOU_3I BeiDou-3 IGSO.
BLOCK_I GPS Block I : SVN 01-11.
BLOCK_II GPS Block II : SVN 13-21.
BLOCK_IIA GPS Block IIA : SVN 22-40.
BLOCK_IIF GPS Block IIF : SVN 62-73.
BLOCK_IIIA GPS Block IIIA : SVN 74-81.
BLOCK_IIR_A GPS Block IIR : SVN 41, 43-46, 51, 54, 56.
BLOCK_IIR_B GPS Block IIR : SVN 47, 59-61.
BLOCK_IIR_M GPS Block IIR-M : SVN 48-50, 52-53, 55, 57-58.
GALILEO_0A Galileo In-Orbit Validation Element A (GIOVE-A).
GALILEO_0B Galileo In-Orbit Validation Element B (GIOVE-B).
GALILEO_1 Galileo IOV : GSAT 0101-0104.
GALILEO_2 Galileo FOC : GSAT 0201-0222.
GLONASS GLONASS : GLONASS no.
GLONASS_K1 GLONASS-K1 : IGS SVN R801-R802 (GLO no.
GLONASS_K2 GLONASS-K2.
GLONASS_M GLONASS-M : GLONASS no.
IRNSS_1GEO IRNSS-1 GEO.
IRNSS_1IGSO IRNSS-1 IGSO.
QZSS QZSS Block I (Michibiki-1).
QZSS_2G QZSS Block II GEO (Michibiki-3).
QZSS_2I QZSS Block II IGSO (Michibiki-2,4).

Method Summary

Modifier and Type	Method and Description
abstract GNSSAttitudeProvider	buildAttitudeProvider(AbsoluteDate validityStart, AbsoluteDate validityEnd, ExtendedPVCoordinatesProvider sun, Frame inertialFrame, int prnNumber) Build an attitude provider suitable for this satellite type.
String	getName() Get the IGS name for the antenna code.
static SatelliteType	parseSatelliteType(String s) Parse a string to get the satellite type.
static SatelliteType	valueOf(String name) Returns the enum constant of this type with the specified name.
static SatelliteType[]	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

BEIDOU_2G

public static final SatelliteType BEIDOU_2G

BeiDou-2 GEO.

BEIDOU_2I

public static final SatelliteType BEIDOU_2I

BeiDou-2 IGSO.

BEIDOU_2M

public static final SatelliteType BEIDOU_2M

BeiDou-2 MEO.

BEIDOU_3I

public static final SatelliteType BEIDOU_3I

BeiDou-3 IGSO.

BLOCK_I

public static final SatelliteType BLOCK_I

GPS Block I : SVN 01-11.

BLOCK_II

public static final SatelliteType BLOCK_II

GPS Block II : SVN 13-21.

BLOCK_IIA

public static final SatelliteType BLOCK_IIA

GPS Block IIA : SVN 22-40.

BLOCK_IIR_A

public static final SatelliteType BLOCK_IIR_A

GPS Block IIR : SVN 41, 43-46, 51, 54, 56.

BLOCK_IIR_B

public static final SatelliteType BLOCK_IIR_B

GPS Block IIR : SVN 47, 59-61.

BLOCK_IIR_M

public static final SatelliteType BLOCK_IIR_M

GPS Block IIR-M : SVN 48-50, 52-53, 55, 57-58.

BLOCK_IIF

public static final SatelliteType BLOCK_IIF

GPS Block IIF : SVN 62-73.

BLOCK_IIIA

public static final SatelliteType BLOCK_IIIA

GPS Block IIIA : SVN 74-81.

GALILEO_0A

public static final SatelliteType GALILEO_0A

Galileo In-Orbit Validation Element A (GIOVE-A).

GALILEO_0B

public static final SatelliteType GALILEO_0B

Galileo In-Orbit Validation Element B (GIOVE-B).

GALILEO_1

public static final SatelliteType GALILEO_1

Galileo IOV : GSAT 0101-0104.

GALILEO_2

public static final SatelliteType GALILEO_2

Galileo FOC : GSAT 0201-0222.

GLONASS

public static final SatelliteType GLONASS

GLONASS : GLONASS no. 201-249, 750-798.

GLONASS_M

public static final SatelliteType GLONASS_M

GLONASS-M : GLONASS no. 701-749, IGS SVN R850-R861 (GLO no. + 100).

GLONASS_K1

public static final SatelliteType GLONASS_K1

GLONASS-K1 : IGS SVN R801-R802 (GLO no. + 100).

GLONASS_K2

public static final SatelliteType GLONASS_K2

GLONASS-K2.

IRNSS_1GEO

public static final SatelliteType IRNSS_1GEO

IRNSS-1 GEO.

IRNSS_1IGSO

public static final SatelliteType IRNSS_1IGSO

IRNSS-1 IGSO.

QZSS

public static final SatelliteType QZSS

QZSS Block I (Michibiki-1).

QZSS_2I

public static final SatelliteType QZSS_2I

QZSS Block II IGSO (Michibiki-2,4).

QZSS_2G

public static final SatelliteType QZSS_2G

QZSS Block II GEO (Michibiki-3).

Method Detail

values

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

Returns:

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

valueOf

public static SatelliteType 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 IGS name for the antenna code.

Returns:

IGS name for the antenna code

buildAttitudeProvider

public abstract GNSSAttitudeProvider buildAttitudeProvider(AbsoluteDate validityStart,
                                                           AbsoluteDate validityEnd,
                                                           ExtendedPVCoordinatesProvider sun,
                                                           Frame inertialFrame,
                                                           int prnNumber)

Build an attitude provider suitable for this satellite type.

Apart from the caller-provided validity interval, Sun provider, frame and PRN number, all construction parameters required for the GNSSAttitudeProvider (for example yaw rates and biases) will be the default ones. If non-default values are needed, the constructor of the appropriate GNSSAttitudeProvider must be called explicitly instead of relying on this general purpose factory method.

Parameters:

validityStart - start of validity for this provider

validityEnd - end of validity for this provider

sun - provider for Sun position

inertialFrame - inertial frame where velocity are computed

prnNumber - number within the satellite system

Returns:

an attitude provider suitable for this satellite type

parseSatelliteType

public static SatelliteType parseSatelliteType(String s)
                                        throws OrekitIllegalArgumentException

Parse a string to get the satellite type.

The name must be either a strict IGS name (like "BLOCK IIR-B") or an IGS name canonicalized by removing all spaces, hypen and underscore characters (like BLOCKIIRB").

Parameters:

s - string to parse (must be a strict IGS name)

Returns:

the satellite type

Throws:

OrekitIllegalArgumentException - if the string does not correspond to a satellite antenna code