agi.foundation.celestial

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

Class EarthOrientationParametersFile

java.lang.Object

agi.foundation.celestial.EarthOrientationParametersFile

public final class EarthOrientationParametersFile
extends Object

Contains static methods to read EOP data in the Celestrak EOP data file format which is documented at https://celestrak.com/SpaceData/EOP-format.asp.

Method Summary

Modifier and Type	Method and Description
static EarthOrientationParameters	downloadData() Downloads the latest EOP file (EOP-v1.1.txt) from an AGI server and returns the contents of the file as EarthOrientationParameters.
static EarthOrientationParameters	downloadData(EarthOrientationParametersReadOptions readOptions, Proxy proxy) Downloads the latest EOP file (EOP-v1.1.txt) from an AGI server and returns the contents of the file as EarthOrientationParameters.
static EarthOrientationParameters	downloadData(Proxy proxy) Downloads the latest EOP file (EOP-v1.1.txt) from an AGI server and returns the contents of the file as EarthOrientationParameters.
static String	downloadRawData() Downloads the latest EOP file (EOP-v1.1.txt) from an AGI server and returns the contents of the file as a string.
static String	downloadRawData(Proxy proxy) Downloads the latest EOP file (EOP-v1.1.txt) from an AGI server and returns the contents of the file as a string.
static EarthOrientationParameters	readData(BufferedReader source) Reads an EOP data file and returns a new EarthOrientationParameters instance initialized with the contents of the file.
static EarthOrientationParameters	readData(BufferedReader source, EarthOrientationParametersReadOptions readOptions) Reads an EOP data file and returns a new EarthOrientationParameters instance initialized with the contents of the file.
static EarthOrientationParameters	readData(String fileName) Reads an EOP data file and returns a new EarthOrientationParameters instance initialized with the contents of the file.
static EarthOrientationParameters	readData(String fileName, EarthOrientationParametersReadOptions readOptions) Reads an EOP data file and returns a new EarthOrientationParameters instance initialized with the contents of the file.

Methods inherited from class java.lang.Object

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

Method Detail

readData

@Nonnull
public static EarthOrientationParameters readData(@Nonnull
                                                            String fileName)

Reads an EOP data file and returns a new EarthOrientationParameters instance initialized with the contents of the file.

Parameters:

fileName - The name of the file from which to read.

Returns:

A new EarthOrientationParameters initialized with the contents of the file.

Throws:

ArgumentNullException - Thrown when the fileName is null.

InvalidDataException - Thrown when there is an error parsing the EOP data specified by the fileName.

readData

@Nonnull
public static EarthOrientationParameters readData(@Nonnull
                                                            String fileName,
                                                            @Nullable
                                                            EarthOrientationParametersReadOptions readOptions)

Reads an EOP data file and returns a new EarthOrientationParameters instance initialized with the contents of the file.

Parameters:

fileName - The name of the file from which to read.

readOptions - Options for reading the file.

Returns:

A new EarthOrientationParameters initialized with the contents of the file.

Throws:

ArgumentNullException - Thrown when the fileName is null.

InvalidDataException - Thrown when there is an error parsing the EOP data specified by the fileName.

readData

@Nonnull
public static EarthOrientationParameters readData(@Nonnull
                                                            BufferedReader source)

Reads an EOP data file and returns a new EarthOrientationParameters instance initialized with the contents of the file.

Parameters:

source - The stream from which to read.

Returns:

A new EarthOrientationParameters initialized with the contents of the file.

Throws:

ArgumentNullException - Thrown when the source is null.

InvalidDataException - Thrown when there is an error parsing the EOP data specified by the source.

readData

@Nonnull
public static EarthOrientationParameters readData(@Nonnull
                                                            BufferedReader source,
                                                            @Nullable
                                                            EarthOrientationParametersReadOptions readOptions)

Reads an EOP data file and returns a new EarthOrientationParameters instance initialized with the contents of the file.

Parameters:

source - The stream from which to read.

readOptions - Options for reading the file.

Returns:

A new EarthOrientationParameters initialized with the contents of the file.

Throws:

ArgumentNullException - Thrown when the source is null.

InvalidDataException - Thrown when there is an error parsing the EOP data specified by the source.

downloadData

@Nonnull
public static EarthOrientationParameters downloadData()

Downloads the latest EOP file (EOP-v1.1.txt) from an AGI server and returns the contents of the file as EarthOrientationParameters. This method connects via HTTPS to ftp.agi.com.

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

Returns:

A EarthOrientationParameters populated with the data returned from the server.

Throws:

InvalidDataException - Thrown when there is an error parsing the EOP data returned from the download.

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

downloadData

@Nonnull
public static EarthOrientationParameters downloadData(@Nullable
                                                                Proxy proxy)

Downloads the latest EOP file (EOP-v1.1.txt) from an AGI server and returns the contents of the file as EarthOrientationParameters. 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 EarthOrientationParameters populated with the data returned from the server.

Throws:

InvalidDataException - Thrown when there is an error parsing the EOP data returned from the download.

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

downloadData

@Nonnull
public static EarthOrientationParameters downloadData(EarthOrientationParametersReadOptions readOptions,
                                                                @Nullable
                                                                Proxy proxy)

Downloads the latest EOP file (EOP-v1.1.txt) from an AGI server and returns the contents of the file as EarthOrientationParameters. This method connects via HTTPS to ftp.agi.com.

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

Parameters:

readOptions - Options for reading the file.

proxy - Proxy to use when connecting. Optional, default is null.

Returns:

A EarthOrientationParameters populated with the data returned from the server.

Throws:

InvalidDataException - Thrown when there is an error parsing the EOP data returned from the download.

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

downloadRawData

@Nonnull
public static String downloadRawData()

Downloads the latest EOP file (EOP-v1.1.txt) from an AGI server and returns the contents of the file as a string. This method connects via HTTPS to ftp.agi.com.

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

Returns:

A string containing the contents of the EOP returned from the server.

Throws:

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

downloadRawData

@Nonnull
public static String downloadRawData(@Nullable
                                               Proxy proxy)

Downloads the latest EOP file (EOP-v1.1.txt) from an AGI server and returns the contents of the file as a string. 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 string containing the contents of the EOP returned from the server.

Throws:

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