Week.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_WEEK_HPP
#define GNSSTK_WEEK_HPP
 
#define timeSystemCheck if(timeSystem != right.timeSystem && \
   timeSystem != TimeSystem::Any && right.timeSystem != TimeSystem::Any) \
   GNSSTK_THROW(InvalidRequest( \
   "CommonTime objects not in same time system, cannot be compared"))
 
#include "TimeTag.hpp"
#include "TimeConverters.hpp"
 
namespace gnsstk
{
 
 
   class Week : public TimeTag
   {
   public:
 
      virtual int Nbits(void) const = 0;
 
      virtual int bitmask(void) const = 0;
 
      virtual int rollover(void) const
      { return bitmask()+1; }
 
      virtual long MJDEpoch(void) const = 0;
 
      int MAXWEEK(void) const
      {
         static const int mw=(CommonTime::END_LIMIT_JDAY - MJD_JDAY - MJDEpoch()) / 7;
         return mw;
      }
 
      Week(int w = 0, TimeSystem ts = TimeSystem::Unknown )
            : week(w)
      { timeSystem = ts; }
 
      virtual ~Week()
      {}
 
      Week& operator=(const Week& right);
 
 
      inline bool operator==(const Week& right) const
      {
            // Any (wildcard) type exception allowed, otherwise must be same time systems
         if(timeSystem != right.timeSystem &&
            timeSystem != TimeSystem::Any && right.timeSystem != TimeSystem::Any)
            return false;
 
         return (week == right.week);
      }
 
      inline bool operator!=(const Week& right) const
      {
         timeSystemCheck;
         return (week != right.week);
      }
 
      inline bool operator<(const Week& right) const
      {
         timeSystemCheck;
         return week < right.week;
      }
 
      inline bool operator<=(const Week& right) const
      {
         timeSystemCheck;
         return week <= right.week;
      }
 
      inline bool operator>(const Week& right) const
      {
         timeSystemCheck;
         return week > right.week;
      }
 
      inline bool operator>=(const Week& right) const
      {
         timeSystemCheck;
         return week >= right.week;
      }
 
 
      inline virtual unsigned int getWeek() const
      {
         return week;
      }
 
      inline virtual unsigned int getModWeek() const
      {
         return (week & bitmask());
      }
 
      inline virtual unsigned int getEpoch() const
      {
         return (week >> Nbits());
      }
 
      inline virtual void getEpochModWeek(unsigned int& e,
                                          unsigned int& w) const
      {
         e = getEpoch();
         w = getModWeek();
      }
 
      inline virtual void setEpoch(unsigned int e)
      {
         week &= bitmask();
         week |= e << Nbits();
      }
 
      inline virtual void setModWeek(unsigned int w)
      {
         week &= ~bitmask();
         week |= w & bitmask();
      }
 
      inline virtual void setEpochModWeek(unsigned int e,
                                          unsigned int w)
      {
         setEpoch(e);
         setModWeek(w);
      }
 
      inline virtual void adjustToYear(unsigned int y)
      {
         long jd1,jd2;
         int ep1,ep2;
         jd1 = convertCalendarToJD(y,1,1);
         ep1 = (jd1 - MJD_JDAY - MJDEpoch())/7/rollover();
         jd2 = convertCalendarToJD(y,12,31);
         ep2 = (jd2 - MJD_JDAY - MJDEpoch())/7/rollover();
         unsigned int halfroll = rollover()/2;
         unsigned int mw = getModWeek();
 
         if(ep1 == ep2)                      // no rollover in given year
            setEpoch(ep1);
         else if(mw <= halfroll)
            setEpoch(ep2);                   // rollover happened before mw -> use ep2
         else
            setEpoch(ep1);                   // rollover happened after mw
      }
 
 
      inline virtual std::string getPrintChars() const
      {
         return "EFGP";
      }
 
      inline virtual std::string getDefaultFormat() const
      {
         return "%04F";
      }
 
      virtual bool isValid() const
      {
         return ((week >= 0) && (week <= MAXWEEK()));
      }
 
      inline virtual void reset()
      {
         week = 0;
      }
 
      virtual unsigned int getDayOfWeek() const = 0;
 
         // member data
      int week;      
   };
 
 
} // namespace
 
#undef timeSystemCheck
 
#endif // GNSSTK_WEEK_HPP