agi.foundation.stk

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

Class StkSatelliteDatabase

java.lang.Object

agi.foundation.stk.StkSatelliteDatabase

public class StkSatelliteDatabase
extends Object

Provides access to an STK satellite database.

The following example shows how to query the satellite database for satellites matching certain criteria:

StkSatelliteDatabase db = new StkSatelliteDatabase(dbDirectory, "stkSatDb");

// Create a query object and then populate it with the properties to query on.
// Regular expressions are used to query on strings.
StkSatelliteDatabaseQuery query = new StkSatelliteDatabaseQuery();
query.setCommonName(Pattern.compile("QUICK"));
query.setMinimumApogee(200000.0);

// Get the database entries matching the query and print out the SSC number of each.
for (StkSatelliteDatabaseEntry entry : db.getEntries(query)) {
    System.out.println(entry.getSatelliteNumber());
}

For more information on the files that define the satellite database, see the the Satellite Database Files topic.

Constructor Summary

Constructors

Constructor and Description
StkSatelliteDatabase(StreamFactory streamFactory) Initializes a new instance which will read data from a ZIP archive containing satellite database files.
StkSatelliteDatabase(String zipFileName) Initializes a new instance which will read data from a ZIP archive containing satellite database files.
StkSatelliteDatabase(String directory, String baseFileName) Initializes a new instance which will read data from a directory of satellite database files.

Method Summary

Modifier and Type	Method and Description
static StkSatelliteDatabase	download() Downloads the current stkSatDbAll satellite database from an AGI server.
static StkSatelliteDatabase	download(Proxy proxy) Downloads the current stkSatDbAll satellite database from an AGI server.
static StkSatelliteDatabase	download(Proxy proxy, StkSatelliteDatabaseType type) Downloads a current satellite database from an AGI server.
static StkSatelliteDatabase	download(StkSatelliteDatabaseType type) Downloads a current satellite database from an AGI server.
ArrayList<StkSatelliteDatabaseEntry>	getEntries() Gets all of the entries in the database.
ArrayList<StkSatelliteDatabaseEntry>	getEntries(StkSatelliteDatabaseQuery query) Gets all of the entries in the database matching a specified query.
GregorianDate	getLastUpdateDate() Gets the last update date reported in the Generic Database (.gd) file, or GregorianDate.MinValue if the file does not exist or does not contain a LastUpdate field.
ArrayList<String>	getMissions() Gets the missions of the spacecraft in the database.
ArrayList<String>	getOwners() Gets the owners of the spacecraft in the database.
String	getVersion() Gets the version number reported in the Generic Database (.gd) file, or "Unknown" if the file does not exist or does not contain a Version field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StkSatelliteDatabase

public StkSatelliteDatabase(@Nonnull
                            String directory,
                            @Nonnull
                            String baseFileName)

Initializes a new instance which will read data from a directory of satellite database files.

Parameters:

directory - The directory in which the satellite database is located.

baseFileName - The base filename (without extension) of the database within the directory.

Throws:

ArgumentNullException - Thrown when directory or baseFileName is null.

StkSatelliteDatabase

public StkSatelliteDatabase(@Nonnull
                            String zipFileName)

Initializes a new instance which will read data from a ZIP archive containing satellite database files.

Parameters:

zipFileName - The ZIP filename containing the satellite database.

Throws:

ArgumentNullException - Thrown when zipFileName is null.

StkSatelliteDatabase

public StkSatelliteDatabase(@Nonnull
                            StreamFactory streamFactory)

Initializes a new instance which will read data from a ZIP archive containing satellite database files.

Parameters:

streamFactory - The factory to use to create streams to read the ZIP file.

Throws:

ArgumentNullException - Thrown when streamFactory is null.

Method Detail

download

@Nonnull
public static StkSatelliteDatabase download()

Downloads the current stkSatDbAll satellite database from an AGI server. This method connects via HTTPS to ftp.agi.com.

Note that an internet connection is required to use this method successfully.

Returns:

A StkSatelliteDatabase containing satellite information.

Throws:

DataUnavailableException - Thrown when the data cannot be retrieved from the server.

download

@Nonnull
public static StkSatelliteDatabase download(@Nullable
                                                      Proxy proxy)

Downloads the current stkSatDbAll satellite database from an AGI server. This method connects via HTTPS to ftp.agi.com.

Note that an internet connection is required to use this method successfully.

Parameters:

proxy - Proxy to use when connecting.

Returns:

A StkSatelliteDatabase containing satellite information.

Throws:

DataUnavailableException - Thrown when the data cannot be retrieved from the server.

download

@Nonnull
public static StkSatelliteDatabase download(@Nonnull
                                                      StkSatelliteDatabaseType type)

Downloads a current satellite database from an AGI server. This method connects via HTTPS to ftp.agi.com.

Note that an internet connection is required to use this method successfully.

Parameters:

type - The type of satellite database to download.

Returns:

A StkSatelliteDatabase containing satellite information.

Throws:

DataUnavailableException - Thrown when the data cannot be retrieved from the server.

download

@Nonnull
public static StkSatelliteDatabase download(@Nullable
                                                      Proxy proxy,
                                                      @Nonnull
                                                      StkSatelliteDatabaseType type)

Downloads a current satellite database from an AGI server. This method connects via HTTPS to ftp.agi.com.

Note that an internet connection is required to use this method successfully.

Parameters:

proxy - Proxy to use when connecting.

type - The type of satellite database to download.

Returns:

A StkSatelliteDatabase containing satellite information.

Throws:

DataUnavailableException - Thrown when the data cannot be retrieved from the server.

getVersion

public final String getVersion()

Gets the version number reported in the Generic Database (.gd) file, or "Unknown" if the file does not exist or does not contain a Version field.

getLastUpdateDate

@Nonnull
public final GregorianDate getLastUpdateDate()

Gets the last update date reported in the Generic Database (.gd) file, or GregorianDate.MinValue if the file does not exist or does not contain a LastUpdate field.

getOwners

@Nonnull
public final ArrayList<String> getOwners()

Gets the owners of the spacecraft in the database.

Returns:

A list of the owners in the database.

getMissions

@Nonnull
public final ArrayList<String> getMissions()

Gets the missions of the spacecraft in the database.

Returns:

A list of the missions in the database.

getEntries

@Nonnull
public final ArrayList<StkSatelliteDatabaseEntry> getEntries()

Gets all of the entries in the database.

Returns:

A list of entries in the database.

getEntries

@Nonnull
public final ArrayList<StkSatelliteDatabaseEntry> getEntries(@Nullable
                                                                       StkSatelliteDatabaseQuery query)

Gets all of the entries in the database matching a specified query.

Parameters:

query - The query that returned entries must match, or null to return all entries.

Returns:

A list of entries in the database that match the query.

Throws:

InvalidDataException - Thrown when a required data file was not found.