SP3File (patrius 4.3 API)

java.lang.Object
- fr.cnes.sirius.patrius.files.sp3.SP3File

All Implemented Interfaces:

OrbitFile, Serializable
```
public class SP3File
extends Object
implements OrbitFile, Serializable
```
Represents a parsed SP3 orbit file.

Author:

Thomas Neidhart

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SP3File.SP3FileType
File type indicator.

static class SP3File.SP3OrbitType
Orbit type indicator.
- Nested classes/interfaces inherited from interface fr.cnes.sirius.patrius.files.general.OrbitFile
  OrbitFile.TimeSystem

Nested Classes
Modifier and Type	Class and Description
`static class`	`SP3File.SP3FileType` File type indicator.
`static class`	`SP3File.SP3OrbitType` Orbit type indicator.

Constructor Summary

Constructors
Constructor and Description

SP3File()
Create a new SP3 file object.

Constructors
Constructor and Description
`SP3File()` Create a new SP3 file object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSatellite(String satId)` Add a new satellite with a given identifier to the list of stored satellites.
`void`	`addSatelliteCoordinate(String satId, SatelliteTimeCoordinate coord)` Adds a new P/V coordinate for a given satellite.
`boolean`	`containsSatellite(String satId)` Tests whether a satellite with the given id is contained in this orbit file.
`String`	`getAgency()` Returns the agency that prepared this SP3 file.
`String`	`getCoordinateSystem()` Returns the coordinate system of the entries in this orbit file.
`String`	`getDataUsed()` Returns the data used indicator from the SP3 file.
`double`	`getDayFraction()` Returns the day fraction for this SP3 file.
`AbsoluteDate`	`getEpoch()` Returns the start epoch of the orbit file.
`double`	`getEpochInterval()` Returns the time interval between epochs (in seconds).
`int`	`getGpsWeek()` Returns the GPS week as contained in the SP3 file.
`int`	`getJulianDay()` Returns the julian day for this SP3 file.
`int`	`getNumberOfEpochs()` Returns the number of epochs contained in this orbit file.
`SP3File.SP3OrbitType`	`getOrbitType()` Returns the `SP3File.SP3OrbitType` for this SP3 file.
`SatelliteInformation`	`getSatellite(int n)` Returns the nth satellite as contained in the SP3 file.
`SatelliteInformation`	`getSatellite(String satId)` Get additional information about a satellite.
`List<SatelliteTimeCoordinate>`	`getSatelliteCoordinates(String satId)` Get the time coordinates for the given satellite.
`int`	`getSatelliteCount()` Get the number of satellites contained in this orbit file.
`Collection<SatelliteInformation>`	`getSatellites()` Returns a `Collection` of `SatelliteInformation` objects for all satellites contained in this orbit file.
`double`	`getSecondsOfWeek()` Returns the seconds of the GPS week as contained in the SP3 file.
`OrbitFile.TimeSystem`	`getTimeSystem()` Returns the `OrbitFile.TimeSystem` used to time-stamp position entries.
`SP3File.SP3FileType`	`getType()` Returns the `SP3File.SP3FileType` associated with this SP3 file.
`void`	`setAgency(String agencyStr)` Set the agency string for this SP3 file.
`void`	`setCoordinateSystem(String system)` Set the coordinate system used for the orbit entries.
`void`	`setDataUsed(String data)` Set the data used indicator for this SP3 file.
`void`	`setDayFraction(double fraction)` Set the day fraction for this SP3 file.
`void`	`setEpoch(AbsoluteDate time)` Set the epoch of the SP3 file.
`void`	`setEpochInterval(double interval)` Set the epoch interval for this SP3 file.
`void`	`setGpsWeek(int week)` Set the GPS week of the SP3 file.
`void`	`setJulianDay(int day)` Set the julian day for this SP3 file.
`void`	`setNumberOfEpochs(int epochCount)` Set the number of epochs as contained in the SP3 file.
`void`	`setOrbitType(SP3File.SP3OrbitType oType)` Set the `SP3File.SP3OrbitType` for this SP3 file.
`void`	`setSecondsOfWeek(double seconds)` Set the seconds of the GPS week for this SP3 file.
`void`	`setTimeSystem(OrbitFile.TimeSystem system)` Set the time system used in this SP3 file.
`void`	`setType(SP3File.SP3FileType fileType)` Set the file type for this SP3 file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SP3File
```
public SP3File()
```
    Create a new SP3 file object.
- Method Detail
  - getType
```
public SP3File.SP3FileType getType()
```
    Returns the SP3File.SP3FileType associated with this SP3 file.
    
    Returns:
    
    the file type for this SP3 file
  - setType
```
public void setType(SP3File.SP3FileType fileType)
```
    Set the file type for this SP3 file.
    
    Parameters:
    
    fileType - the file type to be set
  - getTimeSystem
```
public OrbitFile.TimeSystem getTimeSystem()
```
    Returns the OrbitFile.TimeSystem used to time-stamp position entries.
    
    Specified by:
    
    getTimeSystem in interface OrbitFile
    
    Returns:
    
    the OrbitFile.TimeSystem of the orbit file
  - setTimeSystem
```
public void setTimeSystem(OrbitFile.TimeSystem system)
```
    Set the time system used in this SP3 file.
    
    Parameters:
    
    system - the time system to be set
  - getDataUsed
```
public String getDataUsed()
```
    Returns the data used indicator from the SP3 file.
    
    Returns:
    
    the data used indicator (unparsed)
  - setDataUsed
```
public void setDataUsed(String data)
```
    Set the data used indicator for this SP3 file.
    
    Parameters:
    
    data - the data used indicator to be set
  - getEpoch
```
public AbsoluteDate getEpoch()
```
    Returns the start epoch of the orbit file.
    
    Specified by:
    
    getEpoch in interface OrbitFile
    
    Returns:
    
    the start epoch
  - setEpoch
```
public void setEpoch(AbsoluteDate time)
```
    Set the epoch of the SP3 file.
    
    Parameters:
    
    time - the epoch to be set
  - getGpsWeek
```
public int getGpsWeek()
```
    Returns the GPS week as contained in the SP3 file.
    
    Returns:
    
    the GPS week of the SP3 file
  - setGpsWeek
```
public void setGpsWeek(int week)
```
    Set the GPS week of the SP3 file.
    
    Parameters:
    
    week - the GPS week to be set
  - getSecondsOfWeek
```
public double getSecondsOfWeek()
```
    Returns the seconds of the GPS week as contained in the SP3 file.
    
    Returns:
    
    the seconds of the GPS week
  - setSecondsOfWeek
```
public void setSecondsOfWeek(double seconds)
```
    Set the seconds of the GPS week for this SP3 file.
    
    Parameters:
    
    seconds - the seconds to be set
  - getJulianDay
```
public int getJulianDay()
```
    Returns the julian day for this SP3 file.
    
    Returns:
    
    the julian day
  - setJulianDay
```
public void setJulianDay(int day)
```
    Set the julian day for this SP3 file.
    
    Parameters:
    
    day - the julian day to be set
  - getDayFraction
```
public double getDayFraction()
```
    Returns the day fraction for this SP3 file.
    
    Returns:
    
    the day fraction
  - setDayFraction
```
public void setDayFraction(double fraction)
```
    Set the day fraction for this SP3 file.
    
    Parameters:
    
    fraction - the day fraction to be set
  - getEpochInterval
```
public double getEpochInterval()
```
    Returns the time interval between epochs (in seconds).
    
    Specified by:
    
    getEpochInterval in interface OrbitFile
    
    Returns:
    
    the time interval between epochs
  - setEpochInterval
```
public void setEpochInterval(double interval)
```
    Set the epoch interval for this SP3 file.
    
    Parameters:
    
    interval - the interval between orbit entries
  - getNumberOfEpochs
```
public int getNumberOfEpochs()
```
    Returns the number of epochs contained in this orbit file.
    
    Specified by:
    
    getNumberOfEpochs in interface OrbitFile
    
    Returns:
    
    the number of epochs
  - setNumberOfEpochs
```
public void setNumberOfEpochs(int epochCount)
```
    Set the number of epochs as contained in the SP3 file.
    
    Parameters:
    
    epochCount - the number of epochs to be set
  - getCoordinateSystem
```
public String getCoordinateSystem()
```
    Returns the coordinate system of the entries in this orbit file.
    
    Specified by:
    
    getCoordinateSystem in interface OrbitFile
    
    Returns:
    
    the coordinate system
  - setCoordinateSystem
```
public void setCoordinateSystem(String system)
```
    Set the coordinate system used for the orbit entries.
    
    Parameters:
    
    system - the coordinate system to be set
  - getOrbitType
```
public SP3File.SP3OrbitType getOrbitType()
```
    Returns the SP3File.SP3OrbitType for this SP3 file.
    
    Returns:
    
    the orbit type
  - setOrbitType
```
public void setOrbitType(SP3File.SP3OrbitType oType)
```
    Set the SP3File.SP3OrbitType for this SP3 file.
    
    Parameters:
    
    oType - the orbit type to be set
  - getAgency
```
public String getAgency()
```
    Returns the agency that prepared this SP3 file.
    
    Returns:
    
    the agency
  - setAgency
```
public void setAgency(String agencyStr)
```
    Set the agency string for this SP3 file.
    
    Parameters:
    
    agencyStr - the agency string to be set
  - addSatellite
```
public void addSatellite(String satId)
```
    Add a new satellite with a given identifier to the list of stored satellites.
    
    Parameters:
    
    satId - the satellite identifier
  - getSatellites
```
public Collection<SatelliteInformation> getSatellites()
```
    Returns a Collection of SatelliteInformation objects for all satellites contained in this orbit file.
    
    Specified by:
    
    getSatellites in interface OrbitFile
    
    Returns:
    
    a Collection of SatelliteInformation objects
  - getSatelliteCount
```
public int getSatelliteCount()
```
    Get the number of satellites contained in this orbit file.
    
    Specified by:
    
    getSatelliteCount in interface OrbitFile
    
    Returns:
    
    the number of satellites
  - getSatellite
```
public SatelliteInformation getSatellite(String satId)
```
    Get additional information about a satellite.
    
    Specified by:
    
    getSatellite in interface OrbitFile
    
    Parameters:
    
    satId - the satellite id
    
    Returns:
    
    a SatelliteInformation object describing the satellite if present, null otherwise
  - getSatellite
```
public SatelliteInformation getSatellite(int n)
```
    Returns the nth satellite as contained in the SP3 file.
    
    Parameters:
    
    n - the index of the satellite
    
    Returns:
    
    a SatelliteInformation object for the nth satellite
  - containsSatellite
```
public boolean containsSatellite(String satId)
```
    Tests whether a satellite with the given id is contained in this orbit file.
    
    Specified by:
    
    containsSatellite in interface OrbitFile
    
    Parameters:
    
    satId - the satellite id
    
    Returns:
    
    true if the satellite is contained in the file, false otherwise
  - getSatelliteCoordinates
```
public List<SatelliteTimeCoordinate> getSatelliteCoordinates(String satId)
```
    Get the time coordinates for the given satellite.
    
    Specified by:
    
    getSatelliteCoordinates in interface OrbitFile
    
    Parameters:
    
    satId - the satellite id
    
    Returns:
    
    a List of SatelliteTimeCoordinate entries for this satellite
  - addSatelliteCoordinate
```
public void addSatelliteCoordinate(String satId,
                                   SatelliteTimeCoordinate coord)
```
    Adds a new P/V coordinate for a given satellite.
    
    Parameters:
    
    satId - the satellite identifier
    
    coord - the P/V coordinate of the satellite

Class SP3File

Nested Class Summary

Nested classes/interfaces inherited from interface fr.cnes.sirius.patrius.files.general.OrbitFile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SP3File

Method Detail

getType

setType

getTimeSystem

setTimeSystem

getDataUsed

setDataUsed

getEpoch

setEpoch

getGpsWeek

setGpsWeek

getSecondsOfWeek

setSecondsOfWeek

getJulianDay

setJulianDay

getDayFraction

setDayFraction

getEpochInterval

setEpochInterval

getNumberOfEpochs

setNumberOfEpochs

getCoordinateSystem

setCoordinateSystem

getOrbitType

setOrbitType

getAgency

setAgency

addSatellite

getSatellites

getSatelliteCount

getSatellite

getSatellite

containsSatellite

getSatelliteCoordinates

addSatelliteCoordinate