SP3Header (OREKIT 12.0.1 API)

java.lang.Object
- org.orekit.files.sp3.SP3Header

```
public class SP3Header
extends Object
```
Header for SP3 files.

Since:

12.0

Author:

Luc Maisonobe

Field Summary

Fields
Modifier and Type Field and Description

static String SP3_FRAME_CENTER_STRING
String representation of the center of ephemeris coordinate system.

Fields
Modifier and Type	Field and Description
`static String`	`SP3_FRAME_CENTER_STRING` String representation of the center of ephemeris coordinate system.

Constructor Summary

Constructors
Constructor and Description

SP3Header()
Create a new SP3 header.

Constructors
Constructor and Description
`SP3Header()` Create a new SP3 header.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addComment(String comment)` Add a comment.
`void`	`addSatId(String satId)` Add a satellite identifier.
`double`	`getAccuracy(String satId)` Get the formal accuracy.
`String`	`getAgency()` Returns the agency that prepared this SP3 file.
`double`	`getClockBase()` Get the base for clock/clock-rate accuracy.
`List<String>`	`getComments()` Get the comments.
`String`	`getCoordinateSystem()` Returns the coordinate system of the entries in this orbit file.
`List<DataUsed>`	`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).
`CartesianDerivativesFilter`	`getFilter()` Get the derivatives filter.
`int`	`getGpsWeek()` Returns the GPS week as contained in the SP3 file.
`int`	`getModifiedJulianDay()` Returns the modified julian day for this SP3 file.
`int`	`getNumberOfEpochs()` Returns the number of epochs contained in this orbit file.
`SP3OrbitType`	`getOrbitType()` Returns the `SP3OrbitType` for this SP3 file.
`String`	`getOrbitTypeKey()` Returns the orbit type key for this SP3 file.
`double`	`getPosVelBase()` Get the base for position/velocity accuracy.
`List<String>`	`getSatIds()` Get the satellite identifiers.
`double`	`getSecondsOfWeek()` Returns the seconds of the GPS week as contained in the SP3 file.
`TimeSystem`	`getTimeSystem()` Returns the `TimeSystem` used to time-stamp position entries.
`SP3FileType`	`getType()` Returns the `SP3FileType` associated with this SP3 file.
`char`	`getVersion()` Get the file version.
`void`	`setAccuracy(int index, double accuracy)` Set the accuracy.
`void`	`setAgency(String agencyStr)` Set the agency string for this SP3 file.
`void`	`setClockBase(double clockBase)` Set the base for clock/clock-rate accuracy.
`void`	`setCoordinateSystem(String system)` Set the coordinate system used for the orbit entries.
`void`	`setDataUsed(List<DataUsed> dataUsed)` 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`	`setFilter(CartesianDerivativesFilter filter)` Set the derivatives filter.
`void`	`setGpsWeek(int week)` Set the GPS week of the SP3 file.
`void`	`setModifiedJulianDay(int day)` Set the modified julian day for this SP3 file.
`void`	`setNumberOfEpochs(int epochCount)` Set the number of epochs as contained in the SP3 file.
`void`	`setOrbitTypeKey(String oTypeKey)` Set the orbit type key for this SP3 file.
`void`	`setPosVelBase(double posVelBase)` Set the base for position/velocity accuracy.
`void`	`setSecondsOfWeek(double seconds)` Set the seconds of the GPS week for this SP3 file.
`void`	`setTimeSystem(TimeSystem system)` Set the time system used in this SP3 file.
`void`	`setType(SP3FileType fileType)` Set the file type for this SP3 file.
`void`	`setVersion(char version)` Set the file version.

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

- Field Detail
  - SP3_FRAME_CENTER_STRING
```
public static final String SP3_FRAME_CENTER_STRING
```
    String representation of the center of ephemeris coordinate system.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SP3Header
```
public SP3Header()
```
    Create a new SP3 header.
- Method Detail
  - setVersion
```
public void setVersion(char version)
```
    Set the file version.
    
    Parameters:
    
    version - file version
  - getVersion
```
public char getVersion()
```
    Get the file version.
    
    Returns:
    
    file version
  - setFilter
```
public void setFilter(CartesianDerivativesFilter filter)
```
    Set the derivatives filter.
    
    Parameters:
    
    filter - that indicates which derivatives of position are available.
  - getFilter
```
public CartesianDerivativesFilter getFilter()
```
    Get the derivatives filter.
    
    Returns:
    
    filter with available derivatives
  - getType
```
public SP3FileType getType()
```
    Returns the SP3FileType associated with this SP3 file.
    
    Returns:
    
    the file type for this SP3 file
  - setType
```
public void setType(SP3FileType fileType)
```
    Set the file type for this SP3 file.
    
    Parameters:
    
    fileType - the file type to be set
  - getTimeSystem
```
public TimeSystem getTimeSystem()
```
    Returns the TimeSystem used to time-stamp position entries.
    
    Returns:
    
    the TimeSystem of the orbit file
  - setTimeSystem
```
public void setTimeSystem(TimeSystem system)
```
    Set the time system used in this SP3 file.
    
    Parameters:
    
    system - the time system to be set
  - getDataUsed
```
public List<DataUsed> getDataUsed()
```
    Returns the data used indicator from the SP3 file.
    
    Returns:
    
    the data used indicator
  - setDataUsed
```
public void setDataUsed(List<DataUsed> dataUsed)
```
    Set the data used indicator for this SP3 file.
    
    Parameters:
    
    dataUsed - the data used indicator to be set
  - getEpoch
```
public AbsoluteDate getEpoch()
```
    Returns the start epoch of the orbit file.
    
    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
  - getModifiedJulianDay
```
public int getModifiedJulianDay()
```
    Returns the modified julian day for this SP3 file.
    
    Returns:
    
    the modified julian day
  - setModifiedJulianDay
```
public void setModifiedJulianDay(int day)
```
    Set the modified julian day for this SP3 file.
    
    Parameters:
    
    day - the modified 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).
    
    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.
    
    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.
    
    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 SP3OrbitType getOrbitType()
```
    Returns the SP3OrbitType for this SP3 file.
    
    Returns:
    
    the orbit type
  - getOrbitTypeKey
```
public String getOrbitTypeKey()
```
    Returns the orbit type key for this SP3 file.
    
    Returns:
    
    the orbit type key
  - setOrbitTypeKey
```
public void setOrbitTypeKey(String oTypeKey)
```
    Set the orbit type key for this SP3 file.
    
    Parameters:
    
    oTypeKey - the orbit type key 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
  - setPosVelBase
```
public void setPosVelBase(double posVelBase)
```
    Set the base for position/velocity accuracy.
    
    Parameters:
    
    posVelBase - base for position/velocity accuracy
  - getPosVelBase
```
public double getPosVelBase()
```
    Get the base for position/velocity accuracy.
    
    Returns:
    
    base for position/velocity accuracy
  - setClockBase
```
public void setClockBase(double clockBase)
```
    Set the base for clock/clock-rate accuracy.
    
    Parameters:
    
    clockBase - base for clock/clock-rate accuracy
  - getClockBase
```
public double getClockBase()
```
    Get the base for clock/clock-rate accuracy.
    
    Returns:
    
    base for clock/clock-rate accuracy
  - addSatId
```
public void addSatId(String satId)
```
    Add a satellite identifier.
    
    Parameters:
    
    satId - satellite identifier
  - getSatIds
```
public List<String> getSatIds()
```
    Get the satellite identifiers.
    
    Returns:
    
    satellites identifiers
  - setAccuracy
```
public void setAccuracy(int index,
                        double accuracy)
```
    Set the accuracy.
    
    Parameters:
    
    index - satellite index in getSatIds()
    
    accuracy - in m
  - getAccuracy
```
public double getAccuracy(String satId)
```
    Get the formal accuracy.
    The accuracy is limited by the SP3 standard to be a power of 2 in mm. The value returned here is in meters.
    
    Parameters:
    
    satId - satellite identifier
    
    Returns:
    
    magnitude of one standard deviation, in m.
  - getComments
```
public List<String> getComments()
```
    Get the comments.
    
    Returns:
    
    an unmodifiable view of comments
  - addComment
```
public void addComment(String comment)
```
    Add a comment.
    
    Parameters:
    
    comment - comment to add

Class SP3Header

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SP3_FRAME_CENTER_STRING

Constructor Detail

SP3Header

Method Detail

setVersion

getVersion

setFilter

getFilter

getType

setType

getTimeSystem

setTimeSystem

getDataUsed

setDataUsed

getEpoch

setEpoch

getGpsWeek

setGpsWeek

getSecondsOfWeek

setSecondsOfWeek

getModifiedJulianDay

setModifiedJulianDay

getDayFraction

setDayFraction

getEpochInterval

setEpochInterval

getNumberOfEpochs

setNumberOfEpochs

getCoordinateSystem

setCoordinateSystem

getOrbitType

getOrbitTypeKey

setOrbitTypeKey

getAgency

setAgency

setPosVelBase

getPosVelBase

setClockBase

getClockBase

addSatId

getSatIds

setAccuracy

getAccuracy

getComments

addComment