org.orekit.files.ilrs

Class CPFHeader

java.lang.Object

org.orekit.files.ilrs.ILRSHeader

org.orekit.files.ilrs.CPFHeader

public class CPFHeader
extends ILRSHeader

Container for Consolidated laser ranging Prediction File (CPF) header.

Note: Only the required fields are present.

Since:

10.3

Author:

Bryan Cazabonne

Constructor Summary

Constructors

Constructor and Description
CPFHeader() Empty constructor.

Method Summary

Modifier and Type	Method and Description
double	getCenterOfMassOffset() Get the approximate center of mass to reflector offset.
double	getPrf() Get the Pulse Repetition Frequency (PRF).
Frame	getRefFrame() Get the reference frame.
int	getRefFrameId() Get the reference frame identifier.
int	getRotationalAngleType() Get the rotation angle type.
String	getSource() Get the ephemeris source.
int	getStep() Get the time between table entries.
int	getSubDailySequenceNumber() Get the sub-daily ephemeris sequence number.
double	getTranspClkRef() Get the transponder Clock Reference Time.
double	getTranspOscDrift() Get the transponder Oscillator Drift in parts in 10^15.
double	getTranspTransmitDelay() Get the transponder transmit delay.
double	getTranspUtcOffset() Get the transponder UTC offset.
boolean	isCenterOfMassCorrectionApplied() Get the flag telling if the center of mass correction is applied.
boolean	isCompatibleWithTIVs() Get the flag for compatibility with TIVs.
void	setCenterOfMassOffset(double centerOfMassOffset) Set the approximate center of mass to reflector offset.
void	setIsCenterOfMassCorrectionApplied(boolean isCenterOfMassCorrectionApplied) Set the flag telling if the center of mass correction is applied.
void	setIsCompatibleWithTIVs(boolean isCompatibleWithTIVs) Set the flag for compatibility with TIVs.
void	setPrf(double prf) Set the Pulse Repetition Frequency (PRF).
void	setRefFrame(Frame refFrame) Set the reference frame.
void	setRefFrameId(int refFrameId) Set the reference frame identifier.
void	setRotationalAngleType(int rotationalAngleType) Set the rotation angle type.
void	setSource(String source) Set the ephemeris source.
void	setStep(int step) Set the time between table entries.
void	setSubDailySequenceNumber(int subDailySequenceNumber) Set the sub-daily ephemeris sequence number.
void	setTranspClkRef(double transpClkRef) Set the transponder Clock Reference Time.
void	setTranspOscDrift(double transpOscDrift) Set the transponder Oscillator Drift in parts.
void	setTranspTransmitDelay(double transpTransmitDelay) Set the transponder transmit delay.
void	setTranspUtcOffset(double transpUtcOffset) Set the transponder UTC offset.

Methods inherited from class org.orekit.files.ilrs.ILRSHeader

getEndEpoch, getFormat, getIlrsSatelliteId, getName, getNoradId, getProductionEpoch, getProductionHour, getSequenceNumber, getSic, getStartEpoch, getTargetClass, getTargetLocation, getVersion, setEndEpoch, setFormat, setIlrsSatelliteId, setName, setNoradId, setProductionEpoch, setProductionHour, setSequenceNumber, setSic, setStartEpoch, setTargetClass, setTargetLocation, setVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

CPFHeader

public CPFHeader()

Empty constructor.

This constructor is not strictly necessary, but it prevents spurious javadoc warnings with JDK 18 and later.

Since:

12.0

Method Detail

getSource

public String getSource()

Get the ephemeris source.

Returns:

the ephemeris source

setSource

public void setSource(String source)

Set the ephemeris source.

Parameters:

source - the ephemeris source to set

getSubDailySequenceNumber

public int getSubDailySequenceNumber()

Get the sub-daily ephemeris sequence number.

Returns:

the sub-daily ephemeris sequence number

setSubDailySequenceNumber

public void setSubDailySequenceNumber(int subDailySequenceNumber)

Set the sub-daily ephemeris sequence number.

Parameters:

subDailySequenceNumber - the sub-daily ephemeris sequence number to set

getStep

public int getStep()

Get the time between table entries.

Returns:

the time between table entries in seconds

setStep

public void setStep(int step)

Set the time between table entries.

Parameters:

step - the time to set in seconds

isCompatibleWithTIVs

public boolean isCompatibleWithTIVs()

Get the flag for compatibility with TIVs.

Returns:

true if compatible with TIVs

setIsCompatibleWithTIVs

public void setIsCompatibleWithTIVs(boolean isCompatibleWithTIVs)

Set the flag for compatibility with TIVs.

Parameters:

isCompatibleWithTIVs - true if compatible with TIVs

getRefFrame

public Frame getRefFrame()

Get the reference frame.

Returns:

the reference frame

setRefFrame

public void setRefFrame(Frame refFrame)

Set the reference frame.

Parameters:

refFrame - the reference frame to set

getRefFrameId

public int getRefFrameId()

Get the reference frame identifier.

Returns:

the reference frame

setRefFrameId

public void setRefFrameId(int refFrameId)

Set the reference frame identifier.

Parameters:

refFrameId - the reference frame identifier to set

getRotationalAngleType

public int getRotationalAngleType()

Get the rotation angle type.

Returns:

the rotation angle type

setRotationalAngleType

public void setRotationalAngleType(int rotationalAngleType)

Set the rotation angle type.

Parameters:

rotationalAngleType - the rotation angle type to set

isCenterOfMassCorrectionApplied

public boolean isCenterOfMassCorrectionApplied()

Get the flag telling if the center of mass correction is applied.

Returns:

true if center of mass correction is applied

setIsCenterOfMassCorrectionApplied

public void setIsCenterOfMassCorrectionApplied(boolean isCenterOfMassCorrectionApplied)

Set the flag telling if the center of mass correction is applied.

Parameters:

isCenterOfMassCorrectionApplied - true if center of mass correction is applied

getPrf

public double getPrf()

Get the Pulse Repetition Frequency (PRF).

Returns:

the Pulse Repetition Frequency (PRF) in Hz

setPrf

public void setPrf(double prf)

Set the Pulse Repetition Frequency (PRF).

Parameters:

prf - the ulse Repetition Frequency (PRF) to set in Hz

getTranspTransmitDelay

public double getTranspTransmitDelay()

Get the transponder transmit delay.

Returns:

the transponder transmit delay in seconds

setTranspTransmitDelay

public void setTranspTransmitDelay(double transpTransmitDelay)

Set the transponder transmit delay.

Parameters:

transpTransmitDelay - the transponder transmit delay to set in seconds

getTranspUtcOffset

public double getTranspUtcOffset()

Get the transponder UTC offset.

Returns:

the transponder UTC offset in seconds

setTranspUtcOffset

public void setTranspUtcOffset(double transpUtcOffset)

Set the transponder UTC offset.

Parameters:

transpUtcOffset - the UTC offset to set in seconds

getTranspOscDrift

public double getTranspOscDrift()

Get the transponder Oscillator Drift in parts in 10^15.

Returns:

the transponder Oscillator Drift in parts.

setTranspOscDrift

public void setTranspOscDrift(double transpOscDrift)

Set the transponder Oscillator Drift in parts.

Parameters:

transpOscDrift - the transponder Oscillator Drift in parts in 10^15 to set

getTranspClkRef

public double getTranspClkRef()

Get the transponder Clock Reference Time.

Returns:

the transponder Clock Reference Time

setTranspClkRef

public void setTranspClkRef(double transpClkRef)

Set the transponder Clock Reference Time.

Parameters:

transpClkRef - the transponder Clock Reference Time to set

getCenterOfMassOffset

public double getCenterOfMassOffset()

Get the approximate center of mass to reflector offset.

Returns:

the approximate center of mass to reflector offset in meters

setCenterOfMassOffset

public void setCenterOfMassOffset(double centerOfMassOffset)

Set the approximate center of mass to reflector offset.

Parameters:

centerOfMassOffset - the offset to set in meters