GPSWeekZcount.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_GPSWEEKZCOUNT_HPP
#define GNSSTK_GPSWEEKZCOUNT_HPP
 
#include "GPSWeek.hpp"
#include "TimeConstants.hpp"
#include "TimeSystem.hpp"
 
namespace gnsstk
{
 
 
   class GPSWeekZcount : public GPSWeek
   {
   public:
      static const unsigned int bits19 = 0x7FFFF;
 
      GPSWeekZcount( int w = 0,
                     int z = 0,
                     TimeSystem ts = TimeSystem::GPS )
            : GPSWeek( w ), zcount( z )
      { timeSystem = ts; }
 
      GPSWeekZcount( const GPSWeekZcount& right )
            : GPSWeek( right.week ), zcount( right.zcount )
      { timeSystem = right.timeSystem; }
 
      GPSWeekZcount( const TimeTag& right )
      {
         convertFromCommonTime( right.convertToCommonTime() );
      }
 
      GPSWeekZcount( const CommonTime& right )
      {
         convertFromCommonTime( right );
      }
 
      GPSWeekZcount& operator=( const GPSWeekZcount& right );
 
      virtual ~GPSWeekZcount()
      {}
 
         // The following functions are required by TimeTag.
      virtual CommonTime convertToCommonTime() const;
 
      virtual void convertFromCommonTime( const CommonTime& ct );
 
      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 GPSWeek::getPrintChars() + "wzZcC";
      }
 
      inline virtual std::string getDefaultFormat() const
      {
         return GPSWeek::getDefaultFormat() + " %06Z %P";
      }
 
      virtual bool isValid() const
      {
         return ( GPSWeek::isValid() && zcount < ZCOUNT_PER_WEEK );
      }
 
      inline virtual void reset()
      {
         GPSWeek::reset();
         zcount = 0;
      }
 
 
      inline unsigned int getZcount29() const
      {
         return (getWeek10() << 19) | zcount;
      }
 
      inline unsigned int getZcount32() const
      {
         return (week << 19) | zcount;
      }
 
      GPSWeekZcount& setZcount29(unsigned int z);
 
      GPSWeekZcount& setZcount32(unsigned int z);
 
      inline virtual unsigned int getDayOfWeek() const
      {
         return static_cast<unsigned int>(zcount) / ZCOUNT_PER_DAY;
      }
 
         //
      inline bool operator==( const GPSWeekZcount& right ) const
      {
         return ( GPSWeek::operator==(right) && zcount == right.zcount );
      }
 
      inline bool operator!=( const GPSWeekZcount& right ) const
      {
         return ( !operator==( right ) );
      }
 
      inline bool operator<( const GPSWeekZcount& right ) const
      {
         if( GPSWeek::operator<(right) )
         {
            return true;
         }
         if( GPSWeek::operator>(right) )
         {
            return false;
         }
         if( zcount < right.zcount )
         {
            return true;
         }
         return false;
      }
 
      inline bool operator>( const GPSWeekZcount& right ) const
      {
         return ( !operator<=( right ) );
      }
 
      inline bool operator<=( const GPSWeekZcount& right ) const
      {
         return ( operator<( right ) || operator==( right ) );
      }
 
      inline bool operator>=( const GPSWeekZcount& right ) const
      {
         return ( !operator<( right ) );
      }
 
 
      unsigned long getTotalZcounts() const
         noexcept
      { return (unsigned long)week * ZCOUNT_PER_WEEK + zcount; }
 
      GPSWeekZcount& addWeeks(short inWeeks);
 
      GPSWeekZcount& addZcounts(long inZcounts);
 
      GPSWeekZcount operator++(int);
 
      GPSWeekZcount& operator++();
 
      GPSWeekZcount operator--(int);
 
      GPSWeekZcount& operator--();
 
      GPSWeekZcount operator+(long inZcounts) const;
 
      GPSWeekZcount operator-(long inZcounts) const;
 
      long operator-(const GPSWeekZcount& right) const
         noexcept;
 
      GPSWeekZcount& operator+=(long inZcounts);
 
      GPSWeekZcount& operator-=(long inZcounts);
 
      bool inSameTimeBlock(const GPSWeekZcount& other,
                           unsigned long inZcountBlock,
                           unsigned long inZcountOffset = 0)
         noexcept;
 
      unsigned int zcount;
   };
 
 
} // namespace
 
#endif // GNSSTK_GPSWEEKZCOUNT_HPP