agi.foundation.stk

(agi.foundation.models-2024r3.jar)

Enum StkSatelliteDatabaseType

java.lang.Object

java.lang.Enum<StkSatelliteDatabaseType>

agi.foundation.stk.StkSatelliteDatabaseType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<StkSatelliteDatabaseType>

public enum StkSatelliteDatabaseType
extends Enum<StkSatelliteDatabaseType>
implements Enumeration

Indicates the type of StkSatelliteDatabase to download from an AGI server. AGI maintains several satellite database files, updated daily, each of which contains a different set of data.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL The stkSatDbAll database includes all cataloged objects - both on orbit and decayed - including payloads, debris, rocket bodies, and first-, second- and third-stage objects.
ALL_TWO_LINE_ELEMENTS The stkAllTLE database includes all orbiting objects with a TLE available, including payloads, debris, rocket bodies, etc.
COMMUNICATIONS The stkAllComm database includes all orbiting satellites with a communications mission.
SATELLITES The stkSatDb database includes all payloads - both on orbit and decayed.

Method Summary

Modifier and Type	Method and Description
static StkSatelliteDatabaseType	getDefault() Get the enum constant that is considered to be the default.
static StkSatelliteDatabaseType	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static StkSatelliteDatabaseType	valueOf(String name) Returns the enum constant of this type with the specified name.
static StkSatelliteDatabaseType[]	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

ALL

public static final StkSatelliteDatabaseType ALL

The stkSatDbAll database includes all cataloged objects - both on orbit and decayed - including payloads, debris, rocket bodies, and first-, second- and third-stage objects. Entries are included in the database regardless of TLE availability.

ALL_TWO_LINE_ELEMENTS

public static final StkSatelliteDatabaseType ALL_TWO_LINE_ELEMENTS

The stkAllTLE database includes all orbiting objects with a TLE available, including payloads, debris, rocket bodies, etc. All entries in the database have a corresponding TwoLineElementSet.

SATELLITES

public static final StkSatelliteDatabaseType SATELLITES

The stkSatDb database includes all payloads - both on orbit and decayed. Entries are included in the database regardless of TLE availability.

COMMUNICATIONS

public static final StkSatelliteDatabaseType COMMUNICATIONS

The stkAllComm database includes all orbiting satellites with a communications mission. Entries are included in the database regardless of TLE availability.

Method Detail

values

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

Returns:

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

valueOf

public static StkSatelliteDatabaseType 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

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static StkSatelliteDatabaseType getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static StkSatelliteDatabaseType getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.