GPSWeekSecond.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 GPSWEEKSECOND_HPP
#define GPSWEEKSECOND_HPP
 
#include "WeekSecond.hpp"
 
namespace gnsstk
{
 
 
   class GPSWeekSecond : public WeekSecond
   {
   public:
 
      GPSWeekSecond(unsigned int w = 0,
                    double s = 0.,
                    TimeSystem ts = TimeSystem::GPS)
            : WeekSecond(w,s)
      { timeSystem = ts; }
 
      GPSWeekSecond( const CommonTime& right )
      {
         convertFromCommonTime( right );
      }
 
      ~GPSWeekSecond() {}
 
      int Nbits(void) const
      {
         static const int n=10;
         return n;
      }
 
      int bitmask(void) const
      {
         static const int bm=0x3FF;
         return bm;
      }
 
      long MJDEpoch(void) const
      {
         static const long e=GPS_EPOCH_MJD;
         return e;
      }
 
      inline bool operator==( const GPSWeekSecond& right ) const
      {
         return WeekSecond::operator==( right );
      }
      inline bool operator!=( const GPSWeekSecond& right ) const
      {
         return WeekSecond::operator!=( right );
      }
      inline bool operator<( const GPSWeekSecond& right ) const
      {
         return WeekSecond::operator<( right );
      }
      inline bool operator>( const GPSWeekSecond& right ) const
      {
         return WeekSecond::operator>( right );
      }
      inline bool operator<=( const GPSWeekSecond& right ) const
      {
         return WeekSecond::operator<=( right );
      }
      inline bool operator>=( const GPSWeekSecond& right ) const
      {
         return WeekSecond::operator>=( right );
      }
 
      virtual std::string getPrintChars() const
      {
         return "EFGwgP";
      }
 
      virtual std::string getDefaultFormat() const
      {
         return "%F %g %P";
      }
 
      virtual std::string printf(const std::string& fmt) const
      {
         try {
            using gnsstk::StringUtils::formattedPrint;
 
            std::string rv = fmt;
            rv = formattedPrint( rv, getFormatPrefixInt() + "E",
                                 "Eu", getEpoch() );
            rv = formattedPrint( rv, getFormatPrefixInt() + "F",
                                 "Fu", week );
            rv = formattedPrint( rv, getFormatPrefixInt() + "G",
                                 "Gu", getModWeek() );
            rv = formattedPrint( rv, getFormatPrefixInt() + "w",
                                 "wu", getDayOfWeek() );
            rv = formattedPrint( rv, getFormatPrefixFloat() + "g",
                                 "gf", sow );
            rv = formattedPrint( rv, getFormatPrefixInt() + "P",
                                 "Ps", StringUtils::asString(timeSystem).c_str() );
            return rv;
         }
         catch(gnsstk::StringUtils::StringException& e)
         { GNSSTK_RETHROW(e); }
      }
 
      virtual std::string printError(const std::string& fmt) const
      {
         try {
            using gnsstk::StringUtils::formattedPrint;
            std::string rv = fmt;
 
            rv = formattedPrint( rv, getFormatPrefixInt() + "E",
                                 "Es", "BadGPSepoch");
            rv = formattedPrint( rv, getFormatPrefixInt() + "F",
                                 "Fs", "BadGPSfweek");
            rv = formattedPrint( rv, getFormatPrefixInt() + "G",
                                 "Gs", "BadGPSmweek");
            rv = formattedPrint( rv, getFormatPrefixInt() + "w",
                                 "ws", "BadGPSdow");
            rv = formattedPrint( rv, getFormatPrefixFloat() + "g",
                                 "gs", "BadGPSsow");
            rv = formattedPrint( rv, getFormatPrefixInt() + "P",
                                 "Ps", "BadGPSsys");
            return rv;
         }
         catch(gnsstk::StringUtils::StringException& e)
         { GNSSTK_RETHROW(e); }
      }
 
      bool setFromInfo( const IdToValue& info )
      {
         for( IdToValue::const_iterator i = info.begin(); i != info.end(); i++ )
         {
               // based on the character, we know what to do...
            switch ( i->first )
            {
               case 'E':
                  setEpoch( gnsstk::StringUtils::asInt( i->second ) );
                  break;
               case 'F':
                  week = gnsstk::StringUtils::asInt( i->second );
                  break;
               case 'G':
                  setModWeek( gnsstk::StringUtils::asInt( i->second ) );
                  break;
               case 'w':
                  sow = static_cast<double>(gnsstk::StringUtils::asInt(i->second))*SEC_PER_DAY;
                  break;
               case 'g':
                  sow = gnsstk::StringUtils::asDouble( i->second );
                  break;
               case 'P':
                  timeSystem = gnsstk::StringUtils::asTimeSystem(i->second);
                  break;
               default:
                     // do nothing
                  break;
            };
 
         } // end of for loop
 
         return true;
      }
 
 
      GPSWeekSecond& weekRolloverAdj(const GPSWeekSecond& refTime)
      {
         double diff = sow - refTime.sow;
         if (diff < -HALFWEEK)
         {
            week = refTime.week + 1;
         }
         else if (diff > HALFWEEK)
         {
            week = refTime.week - 1;
         }
         else
         {
            week = refTime.week;
         }
         return *this;
      }
 
   }; // end class GPSWeekSecond
 
 
} // namespace
 
#endif // GPSWEEKSECOND_HPP