TDMFile.java

  1. /* Copyright 2002-2018 CS Systèmes d'Information
  2.  * Licensed to CS Systèmes d'Information (CS) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * CS licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *   http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */

  18. package org.orekit.files.ccsds;

  20. import java.util.ArrayList;
  21. import java.util.Collections;
  22. import java.util.TreeMap;
  23. import java.util.List;
  24. import java.util.Map;

  26. import org.orekit.errors.OrekitException;
  27. import org.orekit.errors.OrekitMessages;
  28. import org.orekit.frames.Frame;
  29. import org.orekit.time.AbsoluteDate;

  31. /** This class stocks all the information of the CCSDS Tracking Data Message file parsed by TDMParser or TDMXMLParser. <p>
  32.  * It contains the header and a list of Observations Blocks each containing
  33.  * TDM metadata and a list of observation data lines. <p>
  34.  * At this level the observations are not Orekit objects but custom object containing a keyword (type of observation),
  35.  * a timetag (date of the observation) and a measurement (value of the observation). <p>
  36.  * It is up to the user to convert these observations to Orekit tracking object (Range, Angular, TurnAroundRange etc...).<p>
  37.  * References:<p>
  38.  *  <a href="https://public.ccsds.org/Pubs/503x0b1c1.pdf">CCSDS 503.0-B-1 recommended standard</a> ("Tracking Data Message", Blue Book, Version 1.0, November 2007).
  39.  * @author Maxime Journot
  40.  * @since 9.0
  41.  */
  42. public class TDMFile {

  44.     /** CCSDS Format version. */
  45.     private double formatVersion;

  47.     /** Header comments. The list contains a string for each line of comment. */
  48.     private List<String> headerComment;

  50.     /** File creation date and time in UTC. */
  51.     private AbsoluteDate creationDate;

  53.     /** Creating agency or operator. */
  54.     private String originator;

  56.     /** List of observation blocks. */
  57.     private List<ObservationsBlock> observationsBlocks;

  59.     /** OEMFile constructor. */
  60.     public TDMFile() {
  61.         observationsBlocks = new ArrayList<>();
  62.     }

  64.     /** Get the CCSDS TDM format version.
  65.      * @return format version
  66.      */
  67.     public double getFormatVersion() {
  68.         return formatVersion;
  69.     }

  71.     /** Set the CCSDS ODM (OPM, OMM or OEM) format version.
  72.      * @param formatVersion the format version to be set
  73.      */
  74.     public void setFormatVersion(final double formatVersion) {
  75.         this.formatVersion = formatVersion;
  76.     }

  78.     /** Get the header comment.
  79.      * @return header comment
  80.      */
  81.     public List<String> getHeaderComment() {
  82.         return headerComment;
  83.     }

  85.     /** Set the header comment.
  86.      * @param headerComment header comment
  87.      */
  88.     public void setHeaderComment(final List<String> headerComment) {
  89.         this.headerComment = new ArrayList<>(headerComment);
  90.     }

  92.     /** Get the file creation date and time in UTC.
  93.      * @return the file creation date and time in UTC.
  94.      */
  95.     public AbsoluteDate getCreationDate() {
  96.         return creationDate;
  97.     }

  99.     /** Set the file creation date and time in UTC.
  100.      * @param creationDate the creation date to be set
  101.      */
  102.     public void setCreationDate(final AbsoluteDate creationDate) {
  103.         this.creationDate = creationDate;
  104.     }

  106.     /** Get the file originator.
  107.      * @return originator the file originator.
  108.      */
  109.     public String getOriginator() {
  110.         return originator;
  111.     }

  113.     /** Set the file originator.
  114.      * @param originator the originator to be set
  115.      */
  116.     public void setOriginator(final String originator) {
  117.         this.originator = originator;
  118.     }

  120.     /** Add a block to the list of observations blocks. */
  121.     public void addObservationsBlock() {
  122.         observationsBlocks.add(new ObservationsBlock());
  123.     }

  125.     /** Get the list of observations blocks as an unmodifiable list.
  126.      * @return the list of observations blocks
  127.      */
  128.     public List<ObservationsBlock> getObservationsBlocks() {
  129.         return Collections.unmodifiableList(observationsBlocks);
  130.     }

  132.     /** Set the list of Observations Blocks.
  133.      * @param observationsBlocks the list of Observations Blocks to set
  134.      */
  135.     public void setObservationsBlocks(final List<ObservationsBlock> observationsBlocks) {
  136.         this.observationsBlocks = new ArrayList<>(observationsBlocks);
  137.     }

  139.     /** Check that, according to the CCSDS standard, every ObservationsBlock has the same time system.
  140.      *  @exception OrekitException if some blocks do not have the same time system
  141.      */
  142.     public void checkTimeSystems() throws OrekitException {
  143.         final CcsdsTimeScale timeSystem = getObservationsBlocks().get(0).getMetaData().getTimeSystem();
  144.         for (final ObservationsBlock block : observationsBlocks) {
  145.             if (!timeSystem.equals(block.getMetaData().getTimeSystem())) {
  146.                 throw new OrekitException(OrekitMessages.CCSDS_TDM_INCONSISTENT_TIME_SYSTEMS,
  147.                                           timeSystem, block.getMetaData().getTimeSystem());
  148.             }
  149.         }
  150.     }

  152.     /** The Observations Block class contain metadata and the list of observation data lines.<p>
  153.      * The reason for which the observations have been separated into blocks is that the different
  154.      * data blocks in a TDM file usually refers to different types of observations.<p>
  155.      * An observation block contains a TDM metadata object and a list of observations.<p>
  156.      * At this level, an observation is not an Orekit object, it is a custom object containing:<p>
  157.      *  - a keyword, the type of the observation;<p>
  158.      *  - a timetag, the date of the observation;<p>
  159.      *  - a measurement, the value of the observation.
  160.      * @author Maxime Journot
  161.      */
  162.     public static class ObservationsBlock {

  164.         /** Meta-data for the block. */
  165.         private TDMMetaData metaData;

  167.         /** List of observations data lines. */
  168.         private List<Observation> observations;

  170.         /** Observations Data Lines comments. The list contains a string for each line of comment. */
  171.         private List<String> observationsComment;

  173.         /** ObservationsBlock constructor. */
  174.         public ObservationsBlock() {
  175.             metaData = new TDMMetaData();
  176.             observations = new ArrayList<>();
  177.             observationsComment = new ArrayList<>();
  178.         }

  180.         /** Get the list of Observations data lines.
  181.          * @return a reference to the internal list of Observations data lines
  182.          */
  183.         public List<Observation> getObservations() {
  184.             return this.observations;
  185.         }

  187.         /** Set the list of Observations Data Lines.
  188.          * @param observations the list of Observations Data Lines to set
  189.          */
  190.         public void setObservations(final List<Observation> observations) {
  191.             this.observations = new ArrayList<>(observations);
  192.         }

  194.         /** Adds an observation data line.
  195.          * @param observation the observation to add to the list
  196.          */
  197.         public void addObservation(final Observation observation) {
  198.             this.observations.add(observation);
  199.         }

  201.         /** Adds an observation data line.
  202.          * @param keyword the keyword
  203.          * @param epoch the timetag
  204.          * @param measurement the measurement
  205.          */
  206.         public void addObservation(final String keyword,
  207.                                    final AbsoluteDate epoch,
  208.                                    final double measurement) {
  209.             this.addObservation(new Observation(keyword, epoch, measurement));
  210.         }

  212.         /** Get the meta-data for the block.
  213.          * @return meta-data for the block
  214.          */
  215.         public TDMMetaData getMetaData() {
  216.             return metaData;
  217.         }

  219.         /** Set the meta-data for the block.
  220.          * @param metaData the meta-data to set
  221.          */
  222.         public void setMetaData(final TDMMetaData metaData) {
  223.             this.metaData = metaData;
  224.         }

  226.         /** Get the observations data lines comment.
  227.          * @return the comment
  228.          */
  229.         public List<String> getObservationsComment() {
  230.             return observationsComment;
  231.         }

  233.         /** Set the observations data lines comment.
  234.          * @param observationsComment the comment to be set
  235.          */
  236.         public void setObservationsComment(final List<String> observationsComment) {
  237.             this.observationsComment = new ArrayList<>(observationsComment);
  238.         }

  240.         /** Add an observation data line comment.
  241.          *  @param observationComment the comment line to add
  242.          */
  243.         public void addObservationComment(final String observationComment) {
  244.             this.observationsComment.add(observationComment);
  245.         }

  247.     }

  249.     /** The Observation class contains the data from an observation line.<p>
  250.      * It is not an Orekit object yet.<p>
  251.      * It is a simple container holding:<p>
  252.      *  - a keyword, the type of the observation;<p>
  253.      *  - a timetag, the epoch of the observation;<p>
  254.      *  - a measurement, the value of the observation.<p>
  255.      * @see Keyword
  256.      * @author mjournot
  257.      */
  258.     public static class Observation {

  260.         /** CCSDS Keyword: the type of the observation. */
  261.         private String keyword;

  263.         /** Epoch: the timetag of the observation. */
  264.         private AbsoluteDate epoch;

  266.         /** Measurement: the value of the observation. */
  267.         private double measurement;

  269.         /** Simple constructor.
  270.          * @param keyword the keyword
  271.          * @param epoch the timetag
  272.          * @param measurement the measurement
  273.          */
  274.         Observation(final String keyword, final AbsoluteDate epoch, final double measurement) {
  275.             this.keyword = keyword;
  276.             this.epoch = epoch;
  277.             this.measurement = measurement;
  278.         }

  280.         /** Getter for the keyword.
  281.          * @return the keyword
  282.          */
  283.         public String getKeyword() {
  284.             return keyword;
  285.         }

  287.         /** Setter for the keyword.
  288.          * @param keyword the keyword to set
  289.          */
  290.         public void setKeyword(final String keyword) {
  291.             this.keyword = keyword;
  292.         }

  294.         /** Getter for the epoch.
  295.          * @return the epoch
  296.          */
  297.         public AbsoluteDate getEpoch() {
  298.             return epoch;
  299.         }

  301.         /** Setter for the epoch.
  302.          * @param epoch the epoch to set
  303.          */
  304.         public void setEpoch(final AbsoluteDate epoch) {
  305.             this.epoch = epoch;
  306.         }

  308.         /** Getter for the measurement.
  309.          * @return the measurement
  310.          */
  311.         public double getMeasurement() {
  312.             return measurement;
  313.         }

  315.         /** Setter for the measurement.
  316.          * @param measurement the measurement to set
  317.          */
  318.         public void setMeasurement(final double measurement) {
  319.             this.measurement = measurement;
  320.         }
  321.     }

  323.     /** The TDMMetadata class gathers the meta-data present in the Tracking Data Message (TDM).<p>
  324.      *  References:<p>
  325.      *  <a href="https://public.ccsds.org/Pubs/503x0b1c1.pdf">CCSDS 503.0-B-1 recommended standard</a>. §3.3 ("Tracking Data Message", Blue Book, Version 1.0, November 2007).
  326.      *
  327.      * @author Maxime Journot
  328.      * @since 9.0
  329.      */
  330.     public static class TDMMetaData {

  332.         /** Time System used in the tracking data session. */
  333.         private CcsdsTimeScale timeSystem;

  335.         /** Start epoch of total time span covered by observations block. */
  336.         private AbsoluteDate startTime;

  338.         /** Start time as read in the file. */
  339.         private String startTimeString;
  340.         /** End epoch of total time span covered by observations block. */
  341.         private AbsoluteDate stopTime;

  343.         /** Stop time as read in the file. */
  344.         private String stopTimeString;

  346.         /** Map of participants in the tracking data session (minimum 1 and up to 5).<p>
  347.          *  Participants may include ground stations, spacecraft, and/or quasars.<p>
  348.          *  Participants represent the classical transmitting parties, transponding parties, and receiving parties.
  349.          */
  350.         private Map<Integer, String> participants;

  352.         /** Tracking mode associated with the Data Section of the segment.<p>
  353.          *  - SEQUENTIAL : Sequential signal path between participants (range, Doppler, angles and line of sight ionosphere calibration);<p>
  354.          *  - SINGLE_DIFF: Differenced data.
  355.          */
  356.         private String mode;

  358.         /** The path shall reflect the signal path by listing the index of each participant
  359.          *  in order, separated by commas, with no inserted white space.<p>
  360.          *  The integers 1, 2, 3, 4, 5 used to specify the signal path correlate
  361.          *  with the indices of the PARTICIPANT keywords.<p>
  362.          *  The first entry in the PATH shall be the transmit participant.<p>
  363.          *  The non-indexed ‘PATH’ keyword shall be used if the MODE is ‘SEQUENTIAL’.<p>
  364.          *  The indexed ‘PATH_1’ and ‘PATH_2’ keywords shall be used where the MODE is ‘SINGLE_DIFF’.
  365.          */
  366.         private String path;

  368.         /** Path 1 (see above). */
  369.         private String path1;

  371.         /** Path 2 (see above). */
  372.         private String path2;

  374.         /** Frequency band for transmitted frequencies. */
  375.         private String transmitBand;

  377.         /** Frequency band for received frequencies. */
  378.         private String receiveBand;

  380.         /** Turn-around ratio numerator.<p>
  381.          *  Numerator of the turn-around ratio that is necessary to calculate the coherent downlink from the uplink frequency.
  382.          */
  383.         private int turnaroundNumerator;

  385.         /** Turn-around ratio denominator .*/
  386.         private int turnaroundDenominator;

  388.         /** Timetag reference.<p>
  389.          *  Provides a reference for time tags in the tracking data.<p>
  390.          *  It indicates whether the timetag associated with the data is the transmit time or the receive time.
  391.          */
  392.         private String timetagRef;

  394.         /** Integration interval. <p>
  395.          *  Provides the Doppler count time in seconds for Doppler data or for the creation
  396.          *  of normal points.
  397.          */
  398.         private double integrationInterval;

  400.         /** Integration reference.<p>
  401.          *  Used in conjunction with timetag reference and integration interval.<p>
  402.          *  Indicates whether the timetag represents the start, middle or end of the integration interval.
  403.          */
  404.         private String integrationRef;

  406.         /** Frequency offset.<p>
  407.          *  A frequency in Hz that must be added to every RECEIVE_FREQ to reconstruct it.
  408.          */
  409.         private double freqOffset;

  411.         /** Range mode.<p>
  412.          *  COHERENT, CONSTANT or ONE_WAY.
  413.          */
  414.         private String rangeMode;

  416.         /** Range modulus.<p>
  417.          *  Modulus of the range observable in the units as specified by the RANGE_UNITS keyword.
  418.          */
  419.         private double rangeModulus;

  421.         /** Range units.<p>
  422.          *  The units for the range observable: 'km', 's' or 'RU' (for 'range units').
  423.          */
  424.         private String rangeUnits;

  426.         /** Angle type.<p>
  427.          *  Type of the antenna geometry represented in the angle data ANGLE_1 and ANGLE_2.<p>
  428.          *  – AZEL for azimuth, elevation (local horizontal);<p>
  429.          *  – RADEC for right ascension, declination or hour angle, declination (needs to be referenced to an inertial frame);<p>
  430.          *  – XEYN for x-east, y-north;<p>
  431.          *  – XSYE for x-south, y-east.<p>
  432.          *  Note: Angle units are always degrees
  433.          */
  434.         private String angleType;

  436.         /** The reference frame specifier, as it appeared in the file. */
  437.         private String referenceFrameString;

  439.         /** Reference frame in which data are given: used in combination with ANGLE_TYPE=RADEC. */
  440.         private Frame referenceFrame;

  442.         /** Transmit delays map.<p>
  443.          *  Specifies a fixed interval of time, in seconds, for the signal to travel from the transmitting
  444.          *  electronics to the transmit point. Each item in the list corresponds to the each participants.
  445.          */
  446.         private Map<Integer, Double> transmitDelays;

  448.         /** Receive delays list.<p>
  449.          *  Specifies a fixed interval of time, in seconds, for the signal to travel from the tracking
  450.          *  point to the receiving electronics. Each item in the list corresponds to the each participants.
  451.          */
  452.         private Map<Integer, Double> receiveDelays;

  454.         /** Data quality.<p>
  455.          *  Estimate of the quality of the data: RAW, DEGRADED or VALIDATED.
  456.          */
  457.         private String dataQuality;

  459.         /** Correction angle 1.<p>
  460.          *  Angle correction that has been added or should be added to the ANGLE_1 data.
  461.          */
  462.         private double correctionAngle1;

  464.         /** Correction angle 2.<p>
  465.          *  Angle correction that has been added or should be added to the ANGLE_2 data.
  466.          */
  467.         private double correctionAngle2;

  469.         /** Correction Doppler.<p>
  470.          *  Doppler correction that has been added or should be added to the DOPPLER data.
  471.          */
  472.         private double correctionDoppler;

  474.         /** Correction Range.<p>
  475.          *  Range correction that has been added or should be added to the RANGE data.
  476.          */
  477.         private double correctionRange;

  479.         /** Correction receive.<p>
  480.          *  Receive correction that has been added or should be added to the RECEIVE data.
  481.          */
  482.         private double correctionReceive;

  484.         /** Correction transmit.<p>
  485.          *  Transmit correction that has been added or should be added to the TRANSMIT data.
  486.          */
  487.         private double correctionTransmit;

  489.         /** Correction applied ? YES/NO<p>
  490.          *  Indicate whethers or not the values associated with the CORRECTION_* keywords have been
  491.          *  applied to the tracking data.
  492.          */
  493.         private String correctionsApplied;

  495.         /** Meta-data comments. The list contains a string for each line of comment. */
  496.         private List<String> comment;

  498.         /** Create a new TDM meta-data.
  499.          */
  500.         public TDMMetaData() {
  501.             participants   = new TreeMap<>();
  502.             transmitDelays = new TreeMap<>();
  503.             receiveDelays  = new TreeMap<>();
  504.             comment        = new ArrayList<>();
  505.         }


  508.         /** Get the Time System that: for OPM, is used for metadata, state vector,
  509.          * maneuver and covariance data, for OMM, is used for metadata, orbit state
  510.          * and covariance data, for OEM, is used for metadata, ephemeris and
  511.          * covariance data.
  512.          * @return the time system
  513.          */
  514.         public CcsdsTimeScale getTimeSystem() {
  515.             return timeSystem;
  516.         }

  518.         /** Set the Time System that: for OPM, is used for metadata, state vector,
  519.          * maneuver and covariance data, for OMM, is used for metadata, orbit state
  520.          * and covariance data, for OEM, is used for metadata, ephemeris and
  521.          * covariance data.
  522.          * @param timeSystem the time system to be set
  523.          */
  524.         public void setTimeSystem(final CcsdsTimeScale timeSystem) {
  525.             this.timeSystem = timeSystem;
  526.         }

  528.         /** Getter for the startTime.
  529.          * @return the startTime
  530.          */
  531.         public AbsoluteDate getStartTime() {
  532.             return startTime;
  533.         }

  535.         /** Setter for the startTime.
  536.          * @param startTime the startTime to set
  537.          */
  538.         public void setStartTime(final AbsoluteDate startTime) {
  539.             this.startTime = startTime;
  540.         }

  542.         /** Getter for the startTime String.
  543.          * @return the startTime String
  544.          */
  545.         public String getStartTimeString() {
  546.             return startTimeString;
  547.         }

  549.         /** Setter for the startTime String.
  550.          * @param startTimeString the startTime String to set
  551.          */
  552.         public void setStartTimeString(final String startTimeString) {
  553.             this.startTimeString = startTimeString;
  554.         }

  556.         /** Getter for the stopTime.
  557.          * @return the stopTime
  558.          */
  559.         public AbsoluteDate getStopTime() {
  560.             return stopTime;
  561.         }

  563.         /** Setter for the stopTime.
  564.          * @param stopTime the stopTime to set
  565.          */
  566.         public void setStopTime(final AbsoluteDate stopTime) {
  567.             this.stopTime = stopTime;
  568.         }

  570.         /** Getter for the stopTime String.
  571.          * @return the stopTime String
  572.          */
  573.         public String getStopTimeString() {
  574.             return stopTimeString;
  575.         }

  577.         /** Setter for the stopTime String.
  578.          * @param stopTimeString the stopTime String to set
  579.          */
  580.         public void setStopTimeString(final String stopTimeString) {
  581.             this.stopTimeString = stopTimeString;
  582.         }

  584.         /** Getter for the participants.
  585.          * @return the participants
  586.          */
  587.         public Map<Integer, String> getParticipants() {
  588.             return participants;
  589.         }

  591.         /** Setter for the participants.
  592.          * @param participants the participants to set
  593.          */
  594.         public void setParticipants(final Map<Integer, String> participants) {
  595.             this.participants = new TreeMap<Integer, String>();
  596.             this.participants.putAll(participants);
  597.         }

  599.         /** Adds a participant to the list.
  600.          * @param participantNumber the number of the participant to add
  601.          * @param participant the name of the participant to add
  602.          */
  603.         public void addParticipant(final int participantNumber, final String participant) {
  604.             this.participants.put(participantNumber, participant);
  605.         }

  607.         /** Getter for the mode.
  608.          * @return the mode
  609.          */
  610.         public String getMode() {
  611.             return mode;
  612.         }

  614.         /** Setter for the mode.
  615.          * @param mode the mode to set
  616.          */
  617.         public void setMode(final String mode) {
  618.             this.mode = mode;
  619.         }

  621.         /** Getter for the path.
  622.          * @return the path
  623.          */
  624.         public String getPath() {
  625.             return path;
  626.         }

  628.         /** Setter for the path.
  629.          * @param path the path to set
  630.          */
  631.         public void setPath(final String path) {
  632.             this.path = path;
  633.         }

  635.         /** Getter for the path1.
  636.          * @return the path1
  637.          */
  638.         public String getPath1() {
  639.             return path1;
  640.         }

  642.         /** Setter for the path1.
  643.          * @param path1 the path1 to set
  644.          */
  645.         public void setPath1(final String path1) {
  646.             this.path1 = path1;
  647.         }

  649.         /** Getter for the path2.
  650.          * @return the path2
  651.          */
  652.         public String getPath2() {
  653.             return path2;
  654.         }

  656.         /** Setter for the path2.
  657.          * @param path2 the path2 to set
  658.          */
  659.         public void setPath2(final String path2) {
  660.             this.path2 = path2;
  661.         }

  663.         /** Getter for the transmitBand.
  664.          * @return the transmitBand
  665.          */
  666.         public String getTransmitBand() {
  667.             return transmitBand;
  668.         }

  670.         /** Setter for the transmitBand.
  671.          * @param transmitBand the transmitBand to set
  672.          */
  673.         public void setTransmitBand(final String transmitBand) {
  674.             this.transmitBand = transmitBand;
  675.         }

  677.         /** Getter for the receiveBand.
  678.          * @return the receiveBand
  679.          */
  680.         public String getReceiveBand() {
  681.             return receiveBand;
  682.         }

  684.         /** Setter for the receiveBand.
  685.          * @param receiveBand the receiveBand to set
  686.          */
  687.         public void setReceiveBand(final String receiveBand) {
  688.             this.receiveBand = receiveBand;
  689.         }

  691.         /** Getter for the turnaroundNumerator.
  692.          * @return the turnaroundNumerator
  693.          */
  694.         public int getTurnaroundNumerator() {
  695.             return turnaroundNumerator;
  696.         }

  698.         /** Setter for the turnaroundNumerator.
  699.          * @param turnaroundNumerator the turnaroundNumerator to set
  700.          */
  701.         public void setTurnaroundNumerator(final int turnaroundNumerator) {
  702.             this.turnaroundNumerator = turnaroundNumerator;
  703.         }

  705.         /** Getter for the turnaroundDenominator.
  706.          * @return the turnaroundDenominator
  707.          */
  708.         public int getTurnaroundDenominator() {
  709.             return turnaroundDenominator;
  710.         }

  712.         /** Setter for the turnaroundDenominator.
  713.          * @param turnaroundDenominator the turnaroundDenominator to set
  714.          */
  715.         public void setTurnaroundDenominator(final int turnaroundDenominator) {
  716.             this.turnaroundDenominator = turnaroundDenominator;
  717.         }

  719.         /** Getter for the timetagRef.
  720.          * @return the timetagRef
  721.          */
  722.         public String getTimetagRef() {
  723.             return timetagRef;
  724.         }

  726.         /** Setter for the timetagRef.
  727.          * @param timetagRef the timetagRef to set
  728.          */
  729.         public void setTimetagRef(final String timetagRef) {
  730.             this.timetagRef = timetagRef;
  731.         }

  733.         /** Getter for the integrationInterval.
  734.          * @return the integrationInterval
  735.          */
  736.         public double getIntegrationInterval() {
  737.             return integrationInterval;
  738.         }

  740.         /** Setter for the integrationInterval.
  741.          * @param integrationInterval the integrationInterval to set
  742.          */
  743.         public void setIntegrationInterval(final double integrationInterval) {
  744.             this.integrationInterval = integrationInterval;
  745.         }

  747.         /** Getter for the integrationRef.
  748.          * @return the integrationRef
  749.          */
  750.         public String getIntegrationRef() {
  751.             return integrationRef;
  752.         }

  754.         /** Setter for the integrationRef.
  755.          * @param integrationRef the integrationRef to set
  756.          */
  757.         public void setIntegrationRef(final String integrationRef) {
  758.             this.integrationRef = integrationRef;
  759.         }

  761.         /** Getter for the freqOffset.
  762.          * @return the freqOffset
  763.          */
  764.         public double getFreqOffset() {
  765.             return freqOffset;
  766.         }

  768.         /** Setter for the freqOffset.
  769.          * @param freqOffset the freqOffset to set
  770.          */
  771.         public void setFreqOffset(final double freqOffset) {
  772.             this.freqOffset = freqOffset;
  773.         }

  775.         /** Getter for the rangeMode.
  776.          * @return the rangeMode
  777.          */
  778.         public String getRangeMode() {
  779.             return rangeMode;
  780.         }

  782.         /** Setter for the rangeMode.
  783.          * @param rangeMode the rangeMode to set
  784.          */
  785.         public void setRangeMode(final String rangeMode) {
  786.             this.rangeMode = rangeMode;
  787.         }

  789.         /** Getter for the rangeModulus.
  790.          * @return the rangeModulus
  791.          */
  792.         public double getRangeModulus() {
  793.             return rangeModulus;
  794.         }

  796.         /** Setter for the rangeModulus.
  797.          * @param rangeModulus the rangeModulus to set
  798.          */
  799.         public void setRangeModulus(final double rangeModulus) {
  800.             this.rangeModulus = rangeModulus;
  801.         }

  803.         /** Getter for the rangeUnits.
  804.          * @return the rangeUnits
  805.          */
  806.         public String getRangeUnits() {
  807.             return rangeUnits;
  808.         }

  810.         /** Setter for the rangeUnits.
  811.          * @param rangeUnits the rangeUnits to set
  812.          */
  813.         public void setRangeUnits(final String rangeUnits) {
  814.             this.rangeUnits = rangeUnits;
  815.         }

  817.         /** Getter for angleType.
  818.          * @return the angleType
  819.          */
  820.         public String getAngleType() {
  821.             return angleType;
  822.         }

  824.         /** Setter for the angleType.
  825.          * @param angleType the angleType to set
  826.          */
  827.         public void setAngleType(final String angleType) {
  828.             this.angleType = angleType;
  829.         }

  831.         /** Get the the value of {@code REFERENCE_FRAME} as an Orekit {@link Frame}.
  832.          * @return The reference frame specified by the {@code REFERENCE_FRAME} keyword.
  833.          */
  834.         public Frame getReferenceFrame() {
  835.             return referenceFrame;
  836.         }

  838.         /** Set the reference frame in which data are given: used for RADEC tracking data.
  839.          * @param refFrame the reference frame to be set
  840.          */
  841.         public void setReferenceFrame(final Frame refFrame) {
  842.             this.referenceFrame = refFrame;
  843.         }

  845.         /** Get the reference frame specifier as it appeared in the file.
  846.          * @return the frame name as it appeared in the file.
  847.          */
  848.         public String getReferenceFrameString() {
  849.             return this.referenceFrameString;
  850.         }

  852.         /** Set the reference frame name.
  853.          * @param frame specifier as it appeared in the file.
  854.          */
  855.         public void setReferenceFrameString(final String frame) {
  856.             this.referenceFrameString = frame;
  857.         }

  859.         /** Getter for the transmitDelays.
  860.          * @return the transmitDelays
  861.          */
  862.         public Map<Integer, Double> getTransmitDelays() {
  863.             return transmitDelays;
  864.         }

  866.         /** Setter for the transmitDelays.
  867.          * @param transmitDelays the transmitDelays to set
  868.          */
  869.         public void setTransmitDelays(final Map<Integer, Double> transmitDelays) {
  870.             this.transmitDelays = new TreeMap<Integer, Double>();
  871.             this.transmitDelays.putAll(transmitDelays);
  872.         }

  874.         /** Adds a transmit delay to the list.
  875.          *  @param participantNumber the number of the participants for which the transmit delay is given
  876.          *  @param transmitDelay the transmit delay value to add
  877.          */
  878.         public void addTransmitDelay(final int participantNumber, final double transmitDelay) {
  879.             this.transmitDelays.put(participantNumber, transmitDelay);
  880.         }

  882.         /** Getter for receiveDelays.
  883.          * @return the receiveDelays
  884.          */
  885.         public Map<Integer, Double> getReceiveDelays() {
  886.             return receiveDelays;
  887.         }

  889.         /** Setter for the receiveDelays.
  890.          * @param receiveDelays the receiveDelays to set
  891.          */
  892.         public void setReceiveDelays(final Map<Integer, Double> receiveDelays) {
  893.             this.receiveDelays = new TreeMap<Integer, Double>();
  894.             this.receiveDelays.putAll(receiveDelays);
  895.         }

  897.         /** Adds a receive delay to the list.
  898.          * @param participantNumber the number of the participants for which the receive delay is given
  899.          * @param receiveDelay the receive delay value to add
  900.          */
  901.         public void addReceiveDelay(final int participantNumber, final double receiveDelay) {
  902.             this.receiveDelays.put(participantNumber, receiveDelay);
  903.         }
  904.         /** Getter for the dataQuality.
  905.          * @return the dataQuality
  906.          */
  907.         public String getDataQuality() {
  908.             return dataQuality;
  909.         }

  911.         /** Setter for the dataQuality.
  912.          * @param dataQuality the dataQuality to set
  913.          */
  914.         public void setDataQuality(final String dataQuality) {
  915.             this.dataQuality = dataQuality;
  916.         }

  918.         /** Getter for the correctionAngle1.
  919.          * @return the correctionAngle1
  920.          */
  921.         public double getCorrectionAngle1() {
  922.             return correctionAngle1;
  923.         }

  925.         /** Setter for the correctionAngle1.
  926.          * @param correctionAngle1 the correctionAngle1 to set
  927.          */
  928.         public void setCorrectionAngle1(final double correctionAngle1) {
  929.             this.correctionAngle1 = correctionAngle1;
  930.         }

  932.         /** Getter for the correctionAngle2.
  933.          * @return the correctionAngle2
  934.          */
  935.         public double getCorrectionAngle2() {
  936.             return correctionAngle2;
  937.         }

  939.         /** Setter for the correctionAngle2.
  940.          * @param correctionAngle2 the correctionAngle2 to set
  941.          */
  942.         public void setCorrectionAngle2(final double correctionAngle2) {
  943.             this.correctionAngle2 = correctionAngle2;
  944.         }

  946.         /** Getter for the correctionDoppler.
  947.          * @return the correctionDoppler
  948.          */
  949.         public double getCorrectionDoppler() {
  950.             return correctionDoppler;
  951.         }

  953.         /** Setter for the correctionDoppler.
  954.          * @param correctionDoppler the correctionDoppler to set
  955.          */
  956.         public void setCorrectionDoppler(final double correctionDoppler) {
  957.             this.correctionDoppler = correctionDoppler;
  958.         }

  960.         /** Getter for the correctionRange.
  961.          * @return the correctionRange
  962.          */
  963.         public double getCorrectionRange() {
  964.             return correctionRange;
  965.         }

  967.         /** Setter for the correctionRange.
  968.          * @param correctionRange the correctionRange to set
  969.          */
  970.         public void setCorrectionRange(final double correctionRange) {
  971.             this.correctionRange = correctionRange;
  972.         }

  974.         /** Getter for the correctionReceive.
  975.          * @return the correctionReceive
  976.          */
  977.         public double getCorrectionReceive() {
  978.             return correctionReceive;
  979.         }

  981.         /** Setter for the correctionReceive.
  982.          * @param correctionReceive the correctionReceive to set
  983.          */
  984.         public void setCorrectionReceive(final double correctionReceive) {
  985.             this.correctionReceive = correctionReceive;
  986.         }

  988.         /** Getter for the correctionTransmit.
  989.          * @return the correctionTransmit
  990.          */
  991.         public double getCorrectionTransmit() {
  992.             return correctionTransmit;
  993.         }

  995.         /** Setter for the correctionTransmit.
  996.          * @param correctionTransmit the correctionTransmit to set
  997.          */
  998.         public void setCorrectionTransmit(final double correctionTransmit) {
  999.             this.correctionTransmit = correctionTransmit;
  1000.         }

  1002.         /** Getter for the correctionApplied.
  1003.          * @return the correctionApplied
  1004.          */
  1005.         public String getCorrectionsApplied() {
  1006.             return correctionsApplied;
  1007.         }

  1009.         /** Setter for the correctionApplied.
  1010.          * @param correctionsApplied the correctionApplied to set
  1011.          */
  1012.         public void setCorrectionsApplied(final String correctionsApplied) {
  1013.             this.correctionsApplied = correctionsApplied;
  1014.         }

  1016.         /** Get the meta-data comment.
  1017.          * @return meta-data comment
  1018.          */
  1019.         public List<String> getComment() {
  1020.             return Collections.unmodifiableList(comment);
  1021.         }

  1023.         /** Set the meta-data comment.
  1024.          * @param comment comment to set
  1025.          */
  1026.         public void setComment(final List<String> comment) {
  1027.             this.comment = new ArrayList<>(comment);
  1028.         }
  1029.     }
  1030. }
Created with JaCoCo 0.7.9.201702052155