GPSWeek.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_GPSWEEK_HPP
#define GNSSTK_GPSWEEK_HPP
 
#include "gnsstk_export.h"
#include "TimeTag.hpp"
 
namespace gnsstk
{
 
 
   class GPSWeek : public TimeTag
   {
   public:
      GNSSTK_EXPORT static const int bits10 = 0x3FF;
      GNSSTK_EXPORT static const int MAX_WEEK;
 
      GPSWeek( int w = 0,
               TimeSystem ts = TimeSystem::Unknown )
            : week(w)
      { timeSystem = ts; }
 
      virtual ~GPSWeek()
      {}
 
      GPSWeek& operator=(const GPSWeek& right);
 
 
      inline bool operator==(const GPSWeek& right) const
      {
         if ((timeSystem != TimeSystem::Any &&
              right.timeSystem != TimeSystem::Any) &&
             timeSystem != right.timeSystem)
            return false;
 
         return week == right.week;
      }
 
      inline bool operator!=(const GPSWeek& right) const
      {
         if ((timeSystem != TimeSystem::Any &&
              right.timeSystem != TimeSystem::Any) &&
             timeSystem != right.timeSystem)
         {
            gnsstk::InvalidRequest ir("CommonTime objects not in same time system, cannot be compared");
            GNSSTK_THROW(ir);
         }
 
         return week != right.week;
      }
 
      inline bool operator<(const GPSWeek& right) const
      {
         if ((timeSystem != TimeSystem::Any &&
              right.timeSystem != TimeSystem::Any) &&
             timeSystem != right.timeSystem)
         {
            gnsstk::InvalidRequest ir("CommonTime objects not in same time system, cannot be compared");
            GNSSTK_THROW(ir);
         }
 
         return week < right.week;
      }
 
      inline bool operator<=(const GPSWeek& right) const
      {
         if ((timeSystem != TimeSystem::Any &&
              right.timeSystem != TimeSystem::Any) &&
             timeSystem != right.timeSystem)
    {
            gnsstk::InvalidRequest ir("CommonTime objects not in same time system, cannot be compared");
            GNSSTK_THROW(ir);
         }
 
         return week <= right.week;
      }
 
      inline bool operator>(const GPSWeek& right) const
      {
         if ((timeSystem != TimeSystem::Any &&
              right.timeSystem != TimeSystem::Any) &&
             timeSystem != right.timeSystem)
    {
            gnsstk::InvalidRequest ir("CommonTime objects not in same time system, cannot be compared");
            GNSSTK_THROW(ir);
         }
 
         return week > right.week;
      }
 
      inline bool operator>=(const GPSWeek& right) const
      {
         if ((timeSystem != TimeSystem::Any &&
              right.timeSystem != TimeSystem::Any) &&
             timeSystem != right.timeSystem)
    {
            gnsstk::InvalidRequest ir("CommonTime objects not in same time system, cannot be compared");
            GNSSTK_THROW(ir);
         }
 
         return week >= right.week;
      }
 
 
      inline virtual unsigned int getEpoch() const
      {
         return week >> 10;
      }
 
      inline virtual unsigned int getWeek10() const
      {
         return week & bits10;
      }
 
      inline virtual void getEpochWeek10(unsigned int& e,
                                         unsigned int& w) const
      {
         e = getEpoch();
         w = getWeek10();
      }
 
      inline virtual void setEpoch(unsigned int e)
      {
         week &= bits10;
         week |= e << 10;
      }
 
      inline virtual void setWeek10(unsigned int w)
      {
         week &= ~bits10;
         week |= w & bits10;
      }
 
      inline virtual void setEpochWeek10(unsigned int e,
                                         unsigned int w)
      {
         setEpoch(e);
         setWeek10(w);
      }
 
      virtual std::string printf( const std::string& fmt ) const;
 
      virtual std::string printError( const std::string& fmt ) const;
 
      virtual bool setFromInfo( const IdToValue& info );
 
      inline virtual std::string getPrintChars() const
      {
         return "EFGP";
      }
 
      inline virtual std::string getDefaultFormat() const
      {
         return "%04F";
      }
 
      virtual bool isValid() const
      {
         return (week >= 0 && week <= MAX_WEEK);
      }
 
      inline virtual void reset()
      {
         week = 0;
      }
 
      virtual unsigned int getDayOfWeek() const = 0;
 
      int week;
   };
 
 
} // namespace
 
#endif // GNSSTK_GPSTIME_HPP