Package org.orekit.gnss.metric.messages.rtcm.msm.headers

Class RtcmMsmHeader

java.lang.Object
org.orekit.gnss.metric.messages.rtcm.msm.headers.RtcmMsmHeader
Direct Known Subclasses:
RtcmMsmBeidouHeader, RtcmMsmGalileoHeader, RtcmMsmGlonassHeader, RtcmMsmGpsHeader, RtcmMsmQzssHeader, RtcmMsmSbasHeader
public abstract class RtcmMsmHeader extends Object
Base class for RTCM MSM message headers, holding common metadata and bit masks.
Since:
14.0
Author:
Nathan Schiffmacher

  • Constructor Details

    • RtcmMsmHeader

      public RtcmMsmHeader()
      Constructor.

  • Method Details

    • getEpochTime

      public double getEpochTime()
      Get the epoch time.
      Returns:
      epoch time within the GNSS week, in seconds

    • setEpochTime

      public void setEpochTime(double epochTime)
      Set the epoch time.
      Parameters:
      epochTime - epoch time within the GNSS week, in seconds

    • getReferenceStation

      public String getReferenceStation()
      Get the Reference Station ID.
      Returns:
      the Reference Station ID

    • setReferenceStation

      public void setReferenceStation(String referenceStation)
      Set the Reference Station ID.
      Parameters:
      referenceStation - the Reference Station ID to set

    • getMultipleMessageFlag

      public boolean getMultipleMessageFlag()
      Get the MSM Multiple Message Flag (DF393).
      Returns:
      true if more MSM messages follow for the epoch, false otherwise

    • setMultipleMessageFlag

      public void setMultipleMessageFlag(boolean multipleMessageFlag)
      Set the MSM Multiple Message Flag (DF393).
      Parameters:
      multipleMessageFlag - true if more MSM messages follow for the epoch, false otherwise

    • getIssueofDataStation

      public int getIssueofDataStation()
      Get the Issue of Data Station.
      Returns:
      the Issue of Data Station

    • setIssueofDataStation

      public void setIssueofDataStation(int issueofDataStation)
      Set the Issue of Data Station.
      Parameters:
      issueofDataStation - the Issue of Data Station to set

    • getClockSteeringIndicator

      public int getClockSteeringIndicator()
      Get the Clock Steering Indicator.
      Returns:
      the Clock Steering Indicator

    • setClockSteeringIndicator

      public void setClockSteeringIndicator(int clockSteeringIndicator)
      Set the Clock Steering Indicator.
      Parameters:
      clockSteeringIndicator - the Clock Steering Indicator to set

    • getExternalClockIndicator

      public int getExternalClockIndicator()
      Get the External Clock Indicator.
      Returns:
      the External Clock Indicator

    • setExternalClockIndicator

      public void setExternalClockIndicator(int externalClockIndicator)
      Set the External Clock Indicator.
      Parameters:
      externalClockIndicator - the External Clock Indicator to set

    • getDivergenceFreeSmoothingIndicator

      public boolean getDivergenceFreeSmoothingIndicator()
      Get the Divergence-free Smoothing Indicator.
      Returns:
      true if divergence-free smoothing is used, false otherwise

    • setDivergenceFreeSmoothingIndicator

      public void setDivergenceFreeSmoothingIndicator(boolean divergenceFreeSmoothingIndicator)
      Set the Divergence-free Smoothing Indicator.
      Parameters:
      divergenceFreeSmoothingIndicator - the Divergence-free Smoothing Indicator to set

    • getSmoothingInterval

      public int getSmoothingInterval()
      Get the Smoothing Interval.
      Returns:
      the Smoothing Interval

    • setSmoothingInterval

      public void setSmoothingInterval(int smoothingInterval)
      Set the Smoothing Interval.
      Parameters:
      smoothingInterval - the Smoothing Interval to set

    • getSatellitesMask

      public long getSatellitesMask()
      Get the satellites mask.
      Returns:
      bit mask indicating which satellites are present

    • setSatellitesMask

      public void setSatellitesMask(long satellitesMask)
      Set the satellites mask.
      Parameters:
      satellitesMask - bit mask indicating which satellites are present

    • getNumberOfSatellites

      public int getNumberOfSatellites()
      Get the number of satellites present in the mask.
      Returns:
      number of satellites with their bit set in the mask

    • getSignalsMask

      public long getSignalsMask()
      Get the signals mask.
      Returns:
      bit mask indicating which signals are present

    • setSignalsMask

      public void setSignalsMask(long signalsMask)
      Set the signals mask.
      Parameters:
      signalsMask - bit mask indicating which signals are present

    • getNumberOfSignals

      public int getNumberOfSignals()
      Get the number of signals present in the mask.
      Returns:
      number of signals with their bit set in the mask

    • getCellsMask

      public long getCellsMask()
      Get the cells mask.
      Returns:
      bit mask indicating which satellite/signal cells are present

    • setCellsMask

      public void setCellsMask(long cellsMask)
      Set the cells mask.
      Parameters:
      cellsMask - bit mask indicating which satellite/signal cells are present

    • getNumberOfCells

      public int getNumberOfCells()
      Get the number of cells present in the mask.
      Returns:
      number of satellite/signal cells with their bit set in the mask

    • convertCellsMask

      public List<Pair<SatInSystem,RtcmMsmSignalId>> convertCellsMask()
      Convert the cells mask to a list of satellite/signal pairs.
      Returns:
      list of satellite/signal pairs corresponding to the active cells

    • convertSatellitesMask

      public abstract List<SatInSystem> convertSatellitesMask()
      Convert the satellites mask to a list of satellites.
      Returns:
      list of satellites present in the MSM message

    • convertSignalsMask

      public abstract List<RtcmMsmSignalId> convertSignalsMask()
      Convert the signals mask to a list of signals.
      Returns:
      list of signals present in the MSM message