SP3EphemerisFile Object

The SP3Ephemeris file, also known as “Precise Ephemeris,” contains data records for the orbit and clock states for the entire GPS constellation. There are two versions of the format, Version A and Version C; FreeFlyer supports the reading and writing of both versions. The data records are nominally provided at 15 minute intervals, the time system of the file is GPS time, and the reference frame for the orbit data is Earth-Centered-Earth-Fixed (ECEF). FreeFlyer automatically converts between ECEF and ICRF when reading and writing SP3EphemerisFiles.

Available In Editions:

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Signatures	Description
SP3EphemerisFile()	Create a SP3EphemerisFile object without specifying an ephemeris file name.
SP3EphemerisFile(String fileName)	Create a SP3EphemerisFile object and set the associated ephemeris file name.

Name	Description	Attributes
Agency	The name of the agency that produced the SP3 Precise Ephemeris. This property is included in the SP3 Precise Ephemeris header. A maximum of 4 characters is allowed.	Type: String Access: Read/Write
ClockEventFlags	An array of Clock Event flags in the SP3 Precise Ephemeris file. Each Clock Event Flag contains an epoch and PRN code for a Spacecraft clock that has an Event. This data is only contained in Version C of the SP3 Precise Ephemeris format.	Type: Array of FlagData Access: Read-Only
ClockPredictionFlags	An array of Clock Prediction flags in the SP3 Precise Ephemeris file. Each Clock Prediction Flag contains an epoch and PRN code for a Spacecraft that has precicted clock data. This data is only contained in Version C of the SP3 Precise Ephemeris format.	Type: Array of FlagData Access: Read-Only
Comments	Comments for the header of the SP3 Precise Ephemeris file.	Type: StringArray Access: Read/Write
DataUsed	The data that was used to produce the SP3 Precise Ephemeris. This property is included in the SP3 Precise Ephemeris header. A maximum of 5 characters is allowed.	Type: String Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
Filename	The filename of the SP3 Precise Ephemeris file.	Type: String Access: Read/Write
FinalEpoch	The final epoch in the SP3 Precise Ephemeris file.	Type: Variable Access: Read-Only Units: day
InitialEpoch	The initial epoch in the SP3 Precise Ephemeris file.	Type: Variable Access: Read-Only Units: day
ManeuverFlags	An array of Maneuver flags in the SP3 Precise Ephemeris file. Each Maneuver Flag contains an epoch and PRN code for a Spacecraft that has a maneuver. This data is only contained in Version C of the SP3 Precise Ephemeris format.	Type: Array of FlagData Access: Read-Only
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
NumberOfEpochs	The number of epochs present in the SP3 Precise Ephemeris file.	Type: Variable Access: Read-Only
NumberOfPRNs	The number of GPS PRNs contained in the SP3 Precise Ephemeris file.	Type: Variable Access: Read-Only
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
OrbitPredictionFlags	An array of Orbit Prediction flags in the SP3 Precise Ephemeris file. Each Orbit Prediction Flag contains an epoch and PRN code for a Spacecraft that has predicted orbit data. This data is only contained in Version C of the SP3 Precise Ephemeris format.	Type: Array of FlagData Access: Read-Only
OrbitType	The type of method that was used to produce orbit for the SP3 Precise Ephemeris. This property is included in the SP3 Precise Ephemeris header. A maximum of 3 characters is allowed.	Type: String Access: Read/Write
SatelliteIds	The identification of all the satellites in the SP3 Precise Ephemeris file. The string includes GNSS Constellation name and the satellite number.	Type: StringArray Access: Read-Only
SetAllPredictionFlags	A flag that indicates whether the all of the clock and orbit information in the SP3 Precise Ephemeris file is predictive or definitive. This property is only used for writing to file, and will apply to all data points. This data is only contained in Version C of the SP3 Precise Ephemeris format.	Type: Variable Access: Read/Write
StepSize	The number of seconds between each ephemeris point.	Type: Variable Access: Read/Write Units: s
Type	The type of data that is included in the SP3 Precise Ephemeris file. The options include position and velocity data, or position only.	Type: Variable Access: Read/Write
Version	The Version of the SP3 Precise Ephemeris file.	Type: Variable Access: Read/Write

Name	Description
AddFlag	Adds the Epoch and numeric SatelliteId code associated with a given Flag to the specified array of Flags to be included in the SP3 Precise Ephemeris file. All Flag data is only included in Version C of the SP3 Precise Ephemeris format.
ClearSavedStates	Clears previous saved states for this object.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReadFromFile	Reads the entire contents of a SP3 Precise Ephemeris file.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.
WriteToFile	Writes a SP3 Precise Ephemeris file containing the ephemeris data from the List of Ephemeris objects provided as an argument.

SP3EphemerisFile Object

Description

Available In Editions:

Timing Precision Mode