org.orekit.files.ilrs

Class CPF

java.lang.Object

org.orekit.files.ilrs.CPF

All Implemented Interfaces:

EphemerisFile<CPF.CPFCoordinate,CPF.CPFEphemeris>

public class CPF
extends Object
implements EphemerisFile<CPF.CPFCoordinate,CPF.CPFEphemeris>

This class stores all the information of the Consolidated laser ranging Prediction File (CPF) parsed by CPFParser. It contains the header and a list of ephemeris entry.

Since:

10.3

Author:

Bryan Cazabonne

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CPF.CPFCoordinate A single record of position and possibility velocity in an SP3 file.
class	CPF.CPFEphemeris An ephemeris entry for a single satellite contains in a CPF file.

Nested classes/interfaces inherited from interface org.orekit.files.general.EphemerisFile

EphemerisFile.EphemerisSegment<C extends TimeStampedPVCoordinates>, EphemerisFile.SatelliteEphemeris<C extends TimeStampedPVCoordinates,S extends EphemerisFile.EphemerisSegment<C>>

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ID Default satellite ID, used if header is null when initializing the ephemeris.

Constructor Summary

Constructors

Constructor and Description
CPF() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addSatelliteCoordinate(CPF.CPFCoordinate coord) Deprecated. as of 11.0.1, replaced by addSatelliteCoordinate(String, CPFCoordinate)
void	addSatelliteCoordinate(String id, CPF.CPFCoordinate coord) Add a new P/V coordinates to the satellite.
void	addSatelliteCoordinates(String id, List<CPF.CPFCoordinate> coord) Adds a set of P/V coordinates to the satellite.
void	addSatelliteVelocityToCPFCoordinate(String id, Vector3D velocity) Add the velocity to the last CPF coordinate entry.
List<String>	getComments() Get the comments contained in the file.
CPFHeader	getHeader() Get the CPF file header.
Map<String,CPF.CPFEphemeris>	getSatellites() Get the loaded ephemeris for each satellite in the file.
TimeScale	getTimeScale() Get the time scale used in CPF file.
void	setFilter(CartesianDerivativesFilter filter) Set the derivatives filter.
void	setInterpolationSample(int interpolationSample) Set the interpolation sample.
void	setMu(double mu) Set the gravitational coefficient.
void	setTimeScale(TimeScale timeScale) Set the time scale.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ID

public static final String DEFAULT_ID

Default satellite ID, used if header is null when initializing the ephemeris.

See Also:

Constant Field Values

Constructor Detail

CPF

public CPF()

Constructor.

Method Detail

getSatellites

public Map<String,CPF.CPFEphemeris> getSatellites()

Get the loaded ephemeris for each satellite in the file. First key corresponds to String value of ILRSHeader.getIlrsSatelliteId()

Specified by:

getSatellites in interface EphemerisFile<CPF.CPFCoordinate,CPF.CPFEphemeris>

Returns:

a map from the satellite's ID to the information about that satellite contained in the file.

getHeader

public CPFHeader getHeader()

Get the CPF file header.

Returns:

the CPF file header

getTimeScale

public TimeScale getTimeScale()

Get the time scale used in CPF file.

Returns:

the time scale used to parse epochs in CPF file.

getComments

public List<String> getComments()

Get the comments contained in the file.

Returns:

the comments contained in the file

addSatelliteCoordinate

@Deprecated
public void addSatelliteCoordinate(CPF.CPFCoordinate coord)

Deprecated. as of 11.0.1, replaced by addSatelliteCoordinate(String, CPFCoordinate)

Adds a new P/V coordinate to the satellite.

If the header has not been read, the DEFAULT_ID is used.

Parameters:

coord - the P/V coordinate of the satellite

addSatelliteCoordinates

public void addSatelliteCoordinates(String id,
                                    List<CPF.CPFCoordinate> coord)

Adds a set of P/V coordinates to the satellite.

Parameters:

id - satellite ILRS identifier

coord - set of coordinates

Since:

11.0.1

addSatelliteCoordinate

public void addSatelliteCoordinate(String id,
                                   CPF.CPFCoordinate coord)

Add a new P/V coordinates to the satellite.

Parameters:

id - satellite ILRS identifier

coord - the P/V coordinate of the satellite

Since:

11.0.1

addSatelliteVelocityToCPFCoordinate

public void addSatelliteVelocityToCPFCoordinate(String id,
                                                Vector3D velocity)

Add the velocity to the last CPF coordinate entry.

Parameters:

id - satellite ILRS identifier

velocity - the velocity vector of the satellite

Since:

11.2

setInterpolationSample

public void setInterpolationSample(int interpolationSample)

Set the interpolation sample.

Parameters:

interpolationSample - interpolation sample

setMu

public void setMu(double mu)

Set the gravitational coefficient.

Parameters:

mu - the coefficient to be set

setTimeScale

public void setTimeScale(TimeScale timeScale)

Set the time scale.

Parameters:

timeScale - use to parse dates in this file.

setFilter

public void setFilter(CartesianDerivativesFilter filter)

Set the derivatives filter.

Parameters:

filter - that indicates which derivatives of position are available.