EngEphemeris.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_EngEphemeris_HPP
#define GNSSTK_EngEphemeris_HPP
 
#include <string>
#include <iostream>
 
#include "EngNav.hpp"
#include "Exception.hpp"
#include "CommonTime.hpp"
#include "Xvt.hpp"
#include "BrcKeplerOrbit.hpp"
#include "BrcClockCorrection.hpp"
 
 
namespace gnsstk
{
 
 
   class EngEphemeris : public EngNav
   {
   public:
      EngEphemeris()
      noexcept;
 
      virtual ~EngEphemeris() {}
 
      bool operator==(const EngEphemeris& right) const noexcept;
      bool operator!=(const EngEphemeris& right) const noexcept
      { return !(operator==(right)); }
 
      bool addSubframe(const uint32_t subframe[10],
                       const int   gpsWeek,
                       const short PRN,
                       const short track);
 
      bool addSubframeNoParity(const uint32_t subframe[10],
                               const int   gpsWeek,
                               const short PRN,
                               const short track);
 
      bool addIncompleteSF1Thru3(const uint32_t  sf1[8],
                                 const uint32_t  sf2[8],
                                 const uint32_t  sf3[8],
                                 const long  sf1TransmitSOW,
                                 const int   gpsWeek,
                                 const short PRN,
                                 const short track);
 
      bool isValid() const noexcept;
 
      bool isData(short subframe) const;
 
      bool isDataSet() const;
 
      void setAccuracy(double acc);
 
      short getFitInterval() const;
 
      static short getFitInterval(short iodc, short fiti);
 
      Xvt svXvt(const CommonTime& t) const;
 
 
         // kinda pointless, huh?
      unsigned char getTLMPreamble() const
         noexcept
      { return 0x8b; }
 
      unsigned getTLMMessage(short subframe) const;
 
      CommonTime getEphemerisEpoch() const;
 
      CommonTime getEpochTime() const;
 
      CommonTime getTransmitTime() const;
 
      CommonTime getTimestamp() const
         noexcept
      { return getEpochTime(); }
 
      std::string getSatSys() const
         noexcept
      { return satSys; }
 
      short getPRNID() const;
 
      short getTracker() const;
 
      double getHOWTime(short subframe) const;
 
      short getASAlert(short subframe) const;
 
      short getFullWeek() const;
 
      short getCodeFlags() const;
 
      double getAccuracy() const;
 
      short getAccFlag() const;
 
      short getHealth() const;
 
      short getL2Pdata() const;
 
      short getIODC() const;
 
      short getIODE() const;
 
      long getAODO() const;
 
      double getToc() const;
 
      double getAf0() const;
 
      double getAf1() const;
 
      double getAf2() const;
 
      double getTgd() const;
 
      double getCus() const;
 
      double getCrs() const;
 
      double getCis() const;
 
      double getCrc() const;
 
      double getCuc() const;
 
      double getCic() const;
 
      double getToe() const;
 
      double getM0() const;
 
      double getDn() const;
 
      double getEcc() const;
 
      double getAhalf() const;
 
      double getA() const;
 
      double getOmega0() const;
 
      double getI0() const;
 
      double getW() const;
 
      double getOmegaDot() const;
 
      double getIDot() const;
 
      double svRelativity(const CommonTime& t) const;
 
      double svClockBias(const CommonTime& t) const;
 
      double svClockDrift(const CommonTime& t) const;
 
      short getFitInt() const;
 
         //double getEphkey() const
 
      long getTot() const;
 
      BrcKeplerOrbit getOrbit() const;
 
      BrcClockCorrection getClock() const;
 
      EngEphemeris& loadData( const std::string satSysArg,
                              const unsigned short tlm[3], const long how[3],
                              const short asalert[3],
                              const short Tracker, const short prn,
                              const short fullweek, const short cflags,
                              const short acc, const short svhealth,
                              const short iodc, const short l2pdata,
                              const long Aodo, const double tgd,
                              const double toc, const double Af2,
                              const double Af1, const double Af0,
                              const short iode, const double crs,
                              const double Dn, const double m0,
                              const double cuc, const double Ecc,
                              const double cus, const double ahalf,
                              const double toe, const short fitInt,
                              const double cic, const double Omega0,
                              const double cis, const double I0,
                              const double crc, const double W,
                              const double OmegaDot, const double IDot );
 
      EngEphemeris& setSF1( unsigned tlm, double how, short asalert,
                            short fullweek, short cflags, short acc,
                            short svhealth, short iodc,
                            short l2pdata, double tgd, double toc, double Af2,
                            double Af1, double Af0, short Tracker, short prn );
 
      EngEphemeris& setSF2( unsigned tlm, double how, short asalert,
                            short iode, double crs, double Dn, double m0,
                            double cuc, double Ecc, double cus, double ahalf,
                            double toe, short fitInt );
 
      EngEphemeris& setSF3( unsigned tlm, double how, short asalert,
                            double cic, double Omega0, double cis, double I0,
                            double crc, double W, double OmegaDot, double IDot);
 
      void dump(std::ostream& s = std::cout) const;
 
      void setFIC(const bool arg);
 
      void dumpTerse(std::ostream& s = std::cout) const;
 
 
      bool haveSubframe[3];
      bool unifiedConvert( const int gpsWeek,
                           const short PRN,
                           const short track);
      uint32_t subframeStore[3][10];
         // True if initialized with FIC data
      bool isFIC;
 
 
      unsigned short tlm_message[3];
      std::string satSys;  
      short PRNID;         
      short tracker;       
      long HOWtime[3];     
      short ASalert[3];    
      short weeknum;       
      short codeflags;     
      short health;        
      short L2Pdata;       
      short IODC;          
      short IODE;          
      long  AODO;          
      short  fitint;       
      double  Tgd;         
 
         // The following is an odd, special case.
      short accFlagTmp;    // Accuracy flag (URA index).  NOTE:  We should
                           // use orbit.getURAoe( ) for this value.  However
                           // we had to have someplace to temporarily store
                           // this value between setSF1( ) and setSF2( ).
                           // Frankly, are the ONLY two methods that should
                           // make use of this member. Its status is NOT
                           // GUARANTEED outside the time setSF1( ) loads it
                           // and setSF2( ) uses it.
 
      BrcClockCorrection bcClock;
 
      BrcKeplerOrbit orbit;
 
      friend std::ostream& operator<<(std::ostream& s,
                                      const EngEphemeris& eph);
 
   }; // class EngEphemeris
 
 
} // namespace
 
#endif