EngNav.hpp

Go to the documentation of this file.

//==============================================================================
//
//  This file is part of GNSSTk, the ARL:UT GNSS Toolkit.
//
//  The GNSSTk is free software; you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as published
//  by the Free Software Foundation; either version 3.0 of the License, or
//  any later version.
//
//  The GNSSTk is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public
//  License along with GNSSTk; if not, write to the Free Software Foundation,
//  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin.
//  Copyright 2004-2022, The Board of Regents of The University of Texas System
//
//==============================================================================
 
//==============================================================================
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin, under contract to an agency or agencies
//  within the U.S. Department of Defense. The U.S. Government retains all
//  rights to use, duplicate, distribute, disclose, or release this software.
//
//  Pursuant to DoD Directive 523024
//
//  DISTRIBUTION STATEMENT A: This software has been approved for public
//                            release, distribution is unlimited.
//
//==============================================================================
 
#ifndef GNSSTK_ENGNAV_HPP
#define GNSSTK_ENGNAV_HPP
 
 
#include <sys/types.h>
#include <ostream>
 
#include "gnsstkplatform.h"
#include "BinUtils.hpp"
#include "GPSWeekSecond.hpp"
#include "NMCTMeta.hpp"
 
namespace gnsstk
{
 
 
   struct DecodeQuant;
 
   class EngNav
   {
   public:
      enum BitConvertType
      {
         BITS8 = 0,
         BITS10 = 1
      };
 
      EngNav() noexcept;
 
      virtual ~EngNav() {}
 
 
      static uint32_t computeParity(uint32_t sfword,
                                    uint32_t psfword,
                                    bool knownUpright=true);
 
      static uint32_t fixParity(uint32_t sfword,
                                uint32_t psfword,
                                bool nib,
                                bool knownUpright = true);
 
      static bool checkParity(const uint32_t input[10], bool knownUpright=true);
      static bool checkParity(const std::vector<uint32_t>& v, bool knownUpright=true);
 
 
      static bool subframeParity(const long input[10]);
 
 
      static inline uint32_t getd30(uint32_t sfword)
      {
         return (sfword & 0x01);
      }
 
      static inline uint32_t getd29(uint32_t sfword)
      {
         return ((sfword & 0x02) >> 1);
      }
 
      static inline unsigned long getHOWTime(uint32_t word2)
      {
         word2 >>= 13;
         word2 &= 0x0001FFFFL;
         return word2 * 6;
      }
 
      static inline unsigned long getTOW(uint32_t word2)
      {
            // It is assumed that the upper 2 bits of word2 are
            // appropriately zero.  If that's not the case, you have
            // other problems.
         return (word2 >> 13);
      }
 
      static inline short getSFID(uint32_t word2)
      {
         word2 >>= 8;
         word2 &= 0x00000007L;
         return word2 ;
      }
 
 
      static bool subframeConvert(const long input[10],
                                  int gpsWeek,
                                  double output[60])
         noexcept;
 
      static bool subframeConvert(const uint32_t input[10],
                                  short gpsWeek,
                                  double output[60])
         noexcept;
 
      static bool convert8bit(int gpsWeek, double *out)
         noexcept;
 
      static bool convert10bit(int gpsWeek, double *out)
         noexcept;
 
      static short convertXBit( short fullGPSWeek,
                                short incompleteGPSWeek,
                                BitConvertType type);
 
      static short getSubframePattern(const long input[10])
         noexcept;
      static short getSubframePattern(const uint32_t input[10])
         noexcept;
 
      static bool sv2page(short svpgid, short& subframe, short& page)
         noexcept;
 
 
      static bool sfpage2svid(short subframe, short page, short& svpgid)
         noexcept;
 
 
      static bool zcount2page(unsigned long zcount,
                              short& subframe, short& page)
         noexcept;
 
      static void dump(std::ostream& s = std::cout);
 
      static bool getNMCTValidity(const uint32_t sf2[10],
                                  unsigned   howWeek,
                                  uint32_t   &aodo,
                                  CommonTime &tnmct,
                                  CommonTime &toe,
                                  CommonTime &tot);
 
      static bool getNMCTValidity(const uint32_t sf2[10],
                                  unsigned   howWeek,
                                  NMCTMeta   &meta)
      {
         return getNMCTValidity(sf2, howWeek, meta.aodo, meta.tnmct, meta.toe,
                                meta.tot);
      }
 
   private:
 
      static void convertQuant(const uint32_t input[10],
                               double output[60],
                               const DecodeQuant& dq)
         noexcept;
   }; // class EngNav
 
 
} // namespace
 
#endif