GPSZcount.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_GPSZCOUNT_HPP
#define GNSSTK_GPSZCOUNT_HPP
 
// system includes
#include <ostream>
 
// GNSSTK includes
#include "gnsstk_export.h"
#include "Exception.hpp"
 
namespace gnsstk
{
 
 
   class GPSZcount
   {
   public:
      GNSSTK_EXPORT static const long ZCOUNT_MINUTE;
      GNSSTK_EXPORT static const long ZCOUNT_HOUR;
      GNSSTK_EXPORT static const long ZCOUNT_DAY;
      GNSSTK_EXPORT static const long ZCOUNT_WEEK;
 
      GPSZcount(short inWeek,
                long inZcount);
 
      GPSZcount(long inFullZcount = 0);
 
      ~GPSZcount() {}
 
      GPSZcount(const GPSZcount& right);
 
      short getWeek() const
      { return week ; }
 
      long getZcount() const
      { return zcount ; }
 
      long getFullZcount() const
      { return (long(getWeek() & 0x3FF) << 19) + getZcount() ; }
 
      double getTotalZcounts() const
      { return double(getWeek()) * ZCOUNT_WEEK + getZcount() ; }
 
      GPSZcount& setWeek(short inWeek);
 
      GPSZcount& setZcount(long inZcount);
 
      GPSZcount& setFullZcount(long inZcount);
 
      GPSZcount& addWeeks(short inWeeks);
 
      GPSZcount& addZcounts(long inZcounts);
 
      GPSZcount operator++(int);
 
      GPSZcount& operator++();
 
      GPSZcount operator--(int);
 
      GPSZcount& operator--();
 
      GPSZcount operator+(long inZcounts) const;
 
      GPSZcount operator-(long inZcounts) const;
 
      double operator-(const GPSZcount& right) const;
 
      long operator%(const long right) const;
 
      GPSZcount& operator+=(long inZcounts);
 
      GPSZcount& operator-=(long inZcounts);
 
      GPSZcount& operator=(const GPSZcount& right);
 
      bool operator<(const GPSZcount& right) const;
      bool operator>(const GPSZcount& right) const;
      bool operator==(const GPSZcount& right) const;
      bool operator!=(const GPSZcount& right) const;
      bool operator<=(const GPSZcount& right) const;
      bool operator>=(const GPSZcount& right) const;
 
      operator std::string() const;
 
      bool inSameTimeBlock(const GPSZcount& other,
                           unsigned long inZcountBlock,
                           unsigned long inZcountOffset = 0);
 
      void dump(std::ostream& out,
                short level = 0) const;
 
   protected:
      short week;    
      long zcount;   
 
      static long validZcount(long z);
 
   };
 
   std::ostream& operator<<(std::ostream& s,
                            const gnsstk::GPSZcount& z);
 
 
} // namespace gnsstk
 
#endif // GNSSTK_GPSZCOUNT_HPP