TDMFile.TDMMetaData (ORbit Extrapolation KIT 10.2 API)

java.lang.Object
- org.orekit.files.ccsds.TDMFile.TDMMetaData

Enclosing class:

TDMFile
```
public static class TDMFile.TDMMetaData
extends Object
```
The TDMMetadata class gathers the meta-data present in the Tracking Data Message (TDM).
References:
CCSDS 503.0-B-1 recommended standard. §3.3 ("Tracking Data Message", Blue Book, Version 1.0, November 2007).

Since:

9.0

Author:

Maxime Journot

Constructor Summary

Constructors
Constructor and Description

TDMMetaData()
Create a new TDM meta-data.

Constructors
Constructor and Description
`TDMMetaData()` Create a new TDM meta-data.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addParticipant(int participantNumber, String participant)` Adds a participant to the list.
`void`	`addReceiveDelay(int participantNumber, double receiveDelay)` Adds a receive delay to the list.
`void`	`addTransmitDelay(int participantNumber, double transmitDelay)` Adds a transmit delay to the list.
`String`	`getAngleType()` Getter for angleType.
`List<String>`	`getComment()` Get the meta-data comment.
`double`	`getCorrectionAngle1()` Getter for the correctionAngle1.
`double`	`getCorrectionAngle2()` Getter for the correctionAngle2.
`double`	`getCorrectionDoppler()` Getter for the correctionDoppler.
`double`	`getCorrectionRange()` Getter for the correctionRange.
`double`	`getCorrectionReceive()` Getter for the correctionReceive.
`String`	`getCorrectionsApplied()` Getter for the correctionApplied.
`double`	`getCorrectionTransmit()` Getter for the correctionTransmit.
`String`	`getDataQuality()` Getter for the dataQuality.
`double`	`getFreqOffset()` Getter for the freqOffset.
`double`	`getIntegrationInterval()` Getter for the integrationInterval.
`String`	`getIntegrationRef()` Getter for the integrationRef.
`String`	`getMode()` Getter for the mode.
`Map<Integer,String>`	`getParticipants()` Getter for the participants.
`String`	`getPath()` Getter for the path.
`String`	`getPath1()` Getter for the path1.
`String`	`getPath2()` Getter for the path2.
`String`	`getRangeMode()` Getter for the rangeMode.
`double`	`getRangeModulus()` Getter for the rangeModulus.
`String`	`getRangeUnits()` Getter for the rangeUnits.
`String`	`getReceiveBand()` Getter for the receiveBand.
`Map<Integer,Double>`	`getReceiveDelays()` Getter for receiveDelays.
`Frame`	`getReferenceFrame()` Get the the value of `REFERENCE_FRAME` as an Orekit `Frame`.
`String`	`getReferenceFrameString()` Get the reference frame specifier as it appeared in the file.
`AbsoluteDate`	`getStartTime()` Getter for the startTime.
`String`	`getStartTimeString()` Getter for the startTime String.
`AbsoluteDate`	`getStopTime()` Getter for the stopTime.
`String`	`getStopTimeString()` Getter for the stopTime String.
`CcsdsTimeScale`	`getTimeSystem()` Get the Time System that: for OPM, is used for metadata, state vector, maneuver and covariance data, for OMM, is used for metadata, orbit state and covariance data, for OEM, is used for metadata, ephemeris and covariance data.
`String`	`getTimetagRef()` Getter for the timetagRef.
`String`	`getTransmitBand()` Getter for the transmitBand.
`Map<Integer,Double>`	`getTransmitDelays()` Getter for the transmitDelays.
`int`	`getTurnaroundDenominator()` Getter for the turnaroundDenominator.
`int`	`getTurnaroundNumerator()` Getter for the turnaroundNumerator.
`void`	`setAngleType(String angleType)` Setter for the angleType.
`void`	`setComment(List<String> comment)` Set the meta-data comment.
`void`	`setCorrectionAngle1(double correctionAngle1)` Setter for the correctionAngle1.
`void`	`setCorrectionAngle2(double correctionAngle2)` Setter for the correctionAngle2.
`void`	`setCorrectionDoppler(double correctionDoppler)` Setter for the correctionDoppler.
`void`	`setCorrectionRange(double correctionRange)` Setter for the correctionRange.
`void`	`setCorrectionReceive(double correctionReceive)` Setter for the correctionReceive.
`void`	`setCorrectionsApplied(String correctionsApplied)` Setter for the correctionApplied.
`void`	`setCorrectionTransmit(double correctionTransmit)` Setter for the correctionTransmit.
`void`	`setDataQuality(String dataQuality)` Setter for the dataQuality.
`void`	`setFreqOffset(double freqOffset)` Setter for the freqOffset.
`void`	`setIntegrationInterval(double integrationInterval)` Setter for the integrationInterval.
`void`	`setIntegrationRef(String integrationRef)` Setter for the integrationRef.
`void`	`setMode(String mode)` Setter for the mode.
`void`	`setParticipants(Map<Integer,String> participants)` Setter for the participants.
`void`	`setPath(String path)` Setter for the path.
`void`	`setPath1(String path1)` Setter for the path1.
`void`	`setPath2(String path2)` Setter for the path2.
`void`	`setRangeMode(String rangeMode)` Setter for the rangeMode.
`void`	`setRangeModulus(double rangeModulus)` Setter for the rangeModulus.
`void`	`setRangeUnits(String rangeUnits)` Setter for the rangeUnits.
`void`	`setReceiveBand(String receiveBand)` Setter for the receiveBand.
`void`	`setReceiveDelays(Map<Integer,Double> receiveDelays)` Setter for the receiveDelays.
`void`	`setReferenceFrame(Frame refFrame)` Set the reference frame in which data are given: used for RADEC tracking data.
`void`	`setReferenceFrameString(String frame)` Set the reference frame name.
`void`	`setStartTime(AbsoluteDate startTime)` Setter for the startTime.
`void`	`setStartTimeString(String startTimeString)` Setter for the startTime String.
`void`	`setStopTime(AbsoluteDate stopTime)` Setter for the stopTime.
`void`	`setStopTimeString(String stopTimeString)` Setter for the stopTime String.
`void`	`setTimeSystem(CcsdsTimeScale timeSystem)` Set the Time System that: for OPM, is used for metadata, state vector, maneuver and covariance data, for OMM, is used for metadata, orbit state and covariance data, for OEM, is used for metadata, ephemeris and covariance data.
`void`	`setTimetagRef(String timetagRef)` Setter for the timetagRef.
`void`	`setTransmitBand(String transmitBand)` Setter for the transmitBand.
`void`	`setTransmitDelays(Map<Integer,Double> transmitDelays)` Setter for the transmitDelays.
`void`	`setTurnaroundDenominator(int turnaroundDenominator)` Setter for the turnaroundDenominator.
`void`	`setTurnaroundNumerator(int turnaroundNumerator)` Setter for the turnaroundNumerator.

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

- Constructor Detail
  - TDMMetaData
```
public TDMMetaData()
```
    Create a new TDM meta-data.
- Method Detail
  - getTimeSystem
```
public CcsdsTimeScale getTimeSystem()
```
    Get the Time System that: for OPM, is used for metadata, state vector, maneuver and covariance data, for OMM, is used for metadata, orbit state and covariance data, for OEM, is used for metadata, ephemeris and covariance data.
    
    Returns:
    
    the time system
  - setTimeSystem
```
public void setTimeSystem(CcsdsTimeScale timeSystem)
```
    Set the Time System that: for OPM, is used for metadata, state vector, maneuver and covariance data, for OMM, is used for metadata, orbit state and covariance data, for OEM, is used for metadata, ephemeris and covariance data.
    
    Parameters:
    
    timeSystem - the time system to be set
  - getStartTime
```
public AbsoluteDate getStartTime()
```
    Getter for the startTime.
    
    Returns:
    
    the startTime
  - setStartTime
```
public void setStartTime(AbsoluteDate startTime)
```
    Setter for the startTime.
    
    Parameters:
    
    startTime - the startTime to set
  - getStartTimeString
```
public String getStartTimeString()
```
    Getter for the startTime String.
    
    Returns:
    
    the startTime String
  - setStartTimeString
```
public void setStartTimeString(String startTimeString)
```
    Setter for the startTime String.
    
    Parameters:
    
    startTimeString - the startTime String to set
  - getStopTime
```
public AbsoluteDate getStopTime()
```
    Getter for the stopTime.
    
    Returns:
    
    the stopTime
  - setStopTime
```
public void setStopTime(AbsoluteDate stopTime)
```
    Setter for the stopTime.
    
    Parameters:
    
    stopTime - the stopTime to set
  - getStopTimeString
```
public String getStopTimeString()
```
    Getter for the stopTime String.
    
    Returns:
    
    the stopTime String
  - setStopTimeString
```
public void setStopTimeString(String stopTimeString)
```
    Setter for the stopTime String.
    
    Parameters:
    
    stopTimeString - the stopTime String to set
  - getParticipants
```
public Map<Integer,String> getParticipants()
```
    Getter for the participants.
    
    Returns:
    
    the participants
  - setParticipants
```
public void setParticipants(Map<Integer,String> participants)
```
    Setter for the participants.
    
    Parameters:
    
    participants - the participants to set
  - addParticipant
```
public void addParticipant(int participantNumber,
                           String participant)
```
    Adds a participant to the list.
    
    Parameters:
    
    participantNumber - the number of the participant to add
    
    participant - the name of the participant to add
  - getMode
```
public String getMode()
```
    Getter for the mode.
    
    Returns:
    
    the mode
  - setMode
```
public void setMode(String mode)
```
    Setter for the mode.
    
    Parameters:
    
    mode - the mode to set
  - getPath
```
public String getPath()
```
    Getter for the path.
    
    Returns:
    
    the path
  - setPath
```
public void setPath(String path)
```
    Setter for the path.
    
    Parameters:
    
    path - the path to set
  - getPath1
```
public String getPath1()
```
    Getter for the path1.
    
    Returns:
    
    the path1
  - setPath1
```
public void setPath1(String path1)
```
    Setter for the path1.
    
    Parameters:
    
    path1 - the path1 to set
  - getPath2
```
public String getPath2()
```
    Getter for the path2.
    
    Returns:
    
    the path2
  - setPath2
```
public void setPath2(String path2)
```
    Setter for the path2.
    
    Parameters:
    
    path2 - the path2 to set
  - getTransmitBand
```
public String getTransmitBand()
```
    Getter for the transmitBand.
    
    Returns:
    
    the transmitBand
  - setTransmitBand
```
public void setTransmitBand(String transmitBand)
```
    Setter for the transmitBand.
    
    Parameters:
    
    transmitBand - the transmitBand to set
  - getReceiveBand
```
public String getReceiveBand()
```
    Getter for the receiveBand.
    
    Returns:
    
    the receiveBand
  - setReceiveBand
```
public void setReceiveBand(String receiveBand)
```
    Setter for the receiveBand.
    
    Parameters:
    
    receiveBand - the receiveBand to set
  - getTurnaroundNumerator
```
public int getTurnaroundNumerator()
```
    Getter for the turnaroundNumerator.
    
    Returns:
    
    the turnaroundNumerator
  - setTurnaroundNumerator
```
public void setTurnaroundNumerator(int turnaroundNumerator)
```
    Setter for the turnaroundNumerator.
    
    Parameters:
    
    turnaroundNumerator - the turnaroundNumerator to set
  - getTurnaroundDenominator
```
public int getTurnaroundDenominator()
```
    Getter for the turnaroundDenominator.
    
    Returns:
    
    the turnaroundDenominator
  - setTurnaroundDenominator
```
public void setTurnaroundDenominator(int turnaroundDenominator)
```
    Setter for the turnaroundDenominator.
    
    Parameters:
    
    turnaroundDenominator - the turnaroundDenominator to set
  - getTimetagRef
```
public String getTimetagRef()
```
    Getter for the timetagRef.
    
    Returns:
    
    the timetagRef
  - setTimetagRef
```
public void setTimetagRef(String timetagRef)
```
    Setter for the timetagRef.
    
    Parameters:
    
    timetagRef - the timetagRef to set
  - getIntegrationInterval
```
public double getIntegrationInterval()
```
    Getter for the integrationInterval.
    
    Returns:
    
    the integrationInterval
  - setIntegrationInterval
```
public void setIntegrationInterval(double integrationInterval)
```
    Setter for the integrationInterval.
    
    Parameters:
    
    integrationInterval - the integrationInterval to set
  - getIntegrationRef
```
public String getIntegrationRef()
```
    Getter for the integrationRef.
    
    Returns:
    
    the integrationRef
  - setIntegrationRef
```
public void setIntegrationRef(String integrationRef)
```
    Setter for the integrationRef.
    
    Parameters:
    
    integrationRef - the integrationRef to set
  - getFreqOffset
```
public double getFreqOffset()
```
    Getter for the freqOffset.
    
    Returns:
    
    the freqOffset
  - setFreqOffset
```
public void setFreqOffset(double freqOffset)
```
    Setter for the freqOffset.
    
    Parameters:
    
    freqOffset - the freqOffset to set
  - getRangeMode
```
public String getRangeMode()
```
    Getter for the rangeMode.
    
    Returns:
    
    the rangeMode
  - setRangeMode
```
public void setRangeMode(String rangeMode)
```
    Setter for the rangeMode.
    
    Parameters:
    
    rangeMode - the rangeMode to set
  - getRangeModulus
```
public double getRangeModulus()
```
    Getter for the rangeModulus.
    
    Returns:
    
    the rangeModulus
  - setRangeModulus
```
public void setRangeModulus(double rangeModulus)
```
    Setter for the rangeModulus.
    
    Parameters:
    
    rangeModulus - the rangeModulus to set
  - getRangeUnits
```
public String getRangeUnits()
```
    Getter for the rangeUnits.
    
    Returns:
    
    the rangeUnits
  - setRangeUnits
```
public void setRangeUnits(String rangeUnits)
```
    Setter for the rangeUnits.
    
    Parameters:
    
    rangeUnits - the rangeUnits to set
  - getAngleType
```
public String getAngleType()
```
    Getter for angleType.
    
    Returns:
    
    the angleType
  - setAngleType
```
public void setAngleType(String angleType)
```
    Setter for the angleType.
    
    Parameters:
    
    angleType - the angleType to set
  - getReferenceFrame
```
public Frame getReferenceFrame()
```
    Get the the value of REFERENCE_FRAME as an Orekit Frame.
    
    Returns:
    
    The reference frame specified by the REFERENCE_FRAME keyword.
  - setReferenceFrame
```
public void setReferenceFrame(Frame refFrame)
```
    Set the reference frame in which data are given: used for RADEC tracking data.
    
    Parameters:
    
    refFrame - the reference frame to be set
  - getReferenceFrameString
```
public String getReferenceFrameString()
```
    Get the reference frame specifier as it appeared in the file.
    
    Returns:
    
    the frame name as it appeared in the file.
  - setReferenceFrameString
```
public void setReferenceFrameString(String frame)
```
    Set the reference frame name.
    
    Parameters:
    
    frame - specifier as it appeared in the file.
  - getTransmitDelays
```
public Map<Integer,Double> getTransmitDelays()
```
    Getter for the transmitDelays.
    
    Returns:
    
    the transmitDelays
  - setTransmitDelays
```
public void setTransmitDelays(Map<Integer,Double> transmitDelays)
```
    Setter for the transmitDelays.
    
    Parameters:
    
    transmitDelays - the transmitDelays to set
  - addTransmitDelay
```
public void addTransmitDelay(int participantNumber,
                             double transmitDelay)
```
    Adds a transmit delay to the list.
    
    Parameters:
    
    participantNumber - the number of the participants for which the transmit delay is given
    
    transmitDelay - the transmit delay value to add
  - getReceiveDelays
```
public Map<Integer,Double> getReceiveDelays()
```
    Getter for receiveDelays.
    
    Returns:
    
    the receiveDelays
  - setReceiveDelays
```
public void setReceiveDelays(Map<Integer,Double> receiveDelays)
```
    Setter for the receiveDelays.
    
    Parameters:
    
    receiveDelays - the receiveDelays to set
  - addReceiveDelay
```
public void addReceiveDelay(int participantNumber,
                            double receiveDelay)
```
    Adds a receive delay to the list.
    
    Parameters:
    
    participantNumber - the number of the participants for which the receive delay is given
    
    receiveDelay - the receive delay value to add
  - getDataQuality
```
public String getDataQuality()
```
    Getter for the dataQuality.
    
    Returns:
    
    the dataQuality
  - setDataQuality
```
public void setDataQuality(String dataQuality)
```
    Setter for the dataQuality.
    
    Parameters:
    
    dataQuality - the dataQuality to set
  - getCorrectionAngle1
```
public double getCorrectionAngle1()
```
    Getter for the correctionAngle1.
    
    Returns:
    
    the correctionAngle1
  - setCorrectionAngle1
```
public void setCorrectionAngle1(double correctionAngle1)
```
    Setter for the correctionAngle1.
    
    Parameters:
    
    correctionAngle1 - the correctionAngle1 to set
  - getCorrectionAngle2
```
public double getCorrectionAngle2()
```
    Getter for the correctionAngle2.
    
    Returns:
    
    the correctionAngle2
  - setCorrectionAngle2
```
public void setCorrectionAngle2(double correctionAngle2)
```
    Setter for the correctionAngle2.
    
    Parameters:
    
    correctionAngle2 - the correctionAngle2 to set
  - getCorrectionDoppler
```
public double getCorrectionDoppler()
```
    Getter for the correctionDoppler.
    
    Returns:
    
    the correctionDoppler
  - setCorrectionDoppler
```
public void setCorrectionDoppler(double correctionDoppler)
```
    Setter for the correctionDoppler.
    
    Parameters:
    
    correctionDoppler - the correctionDoppler to set
  - getCorrectionRange
```
public double getCorrectionRange()
```
    Getter for the correctionRange.
    
    Returns:
    
    the correctionRange
  - setCorrectionRange
```
public void setCorrectionRange(double correctionRange)
```
    Setter for the correctionRange.
    
    Parameters:
    
    correctionRange - the correctionRange to set
  - getCorrectionReceive
```
public double getCorrectionReceive()
```
    Getter for the correctionReceive.
    
    Returns:
    
    the correctionReceive
  - setCorrectionReceive
```
public void setCorrectionReceive(double correctionReceive)
```
    Setter for the correctionReceive.
    
    Parameters:
    
    correctionReceive - the correctionReceive to set
  - getCorrectionTransmit
```
public double getCorrectionTransmit()
```
    Getter for the correctionTransmit.
    
    Returns:
    
    the correctionTransmit
  - setCorrectionTransmit
```
public void setCorrectionTransmit(double correctionTransmit)
```
    Setter for the correctionTransmit.
    
    Parameters:
    
    correctionTransmit - the correctionTransmit to set
  - getCorrectionsApplied
```
public String getCorrectionsApplied()
```
    Getter for the correctionApplied.
    
    Returns:
    
    the correctionApplied
  - setCorrectionsApplied
```
public void setCorrectionsApplied(String correctionsApplied)
```
    Setter for the correctionApplied.
    
    Parameters:
    
    correctionsApplied - the correctionApplied to set
  - getComment
```
public List<String> getComment()
```
    Get the meta-data comment.
    
    Returns:
    
    meta-data comment
  - setComment
```
public void setComment(List<String> comment)
```
    Set the meta-data comment.
    
    Parameters:
    
    comment - comment to set

Class TDMFile.TDMMetaData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TDMMetaData

Method Detail

getTimeSystem

setTimeSystem

getStartTime

setStartTime

getStartTimeString

setStartTimeString

getStopTime

setStopTime

getStopTimeString

setStopTimeString

getParticipants

setParticipants

addParticipant

getMode

setMode

getPath

setPath

getPath1

setPath1

getPath2

setPath2

getTransmitBand

setTransmitBand

getReceiveBand

setReceiveBand

getTurnaroundNumerator

setTurnaroundNumerator

getTurnaroundDenominator

setTurnaroundDenominator

getTimetagRef

setTimetagRef

getIntegrationInterval

setIntegrationInterval

getIntegrationRef

setIntegrationRef

getFreqOffset

setFreqOffset

getRangeMode

setRangeMode

getRangeModulus

setRangeModulus

getRangeUnits

setRangeUnits

getAngleType

setAngleType

getReferenceFrame

setReferenceFrame

getReferenceFrameString

setReferenceFrameString

getTransmitDelays

setTransmitDelays

addTransmitDelay

getReceiveDelays

setReceiveDelays

addReceiveDelay

getDataQuality

setDataQuality

getCorrectionAngle1

setCorrectionAngle1

getCorrectionAngle2

setCorrectionAngle2

getCorrectionDoppler

setCorrectionDoppler

getCorrectionRange

setCorrectionRange

getCorrectionReceive

setCorrectionReceive

getCorrectionTransmit

setCorrectionTransmit

getCorrectionsApplied

setCorrectionsApplied

getComment

setComment