GPSZcount.hpp

Go to the documentation of this file.

#pragma ident "$Id: GPSZcount.hpp 500 2007-04-27 12:02:53Z ocibu $"



#ifndef GPSTK_GPSZCOUNT_HPP
#define GPSTK_GPSZCOUNT_HPP

//============================================================================
//
//  This file is part of GPSTk, the GPS Toolkit.
//
//  The GPSTk 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 2.1 of the License, or
//  any later version.
//
//  The GPSTk 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 GPSTk; if not, write to the Free Software Foundation,
//  Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//  
//  Copyright 2004, The University of Texas at Austin
//
//============================================================================

//============================================================================
//
//This software 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.
//
//=============================================================================

// system includes
#include <ostream>

// GPSTK includes
#include "Exception.hpp"

namespace gpstk
{

   class GPSZcount
   {
   public:
      static const long ZCOUNT_MINUTE;
      static const long ZCOUNT_HOUR;
      static const long ZCOUNT_DAY;
      static const long ZCOUNT_WEEK;

      GPSZcount(short inWeek,
                long inZcount)
         throw(gpstk::InvalidParameter) ;
      
      GPSZcount(long inFullZcount = 0) 
         throw(gpstk::InvalidParameter) ;
      
      ~GPSZcount() throw() {}
      
      GPSZcount(const GPSZcount& right)
         throw() ;
      
      short getWeek() const throw()
      { return week ; }
      
      long getZcount() const throw()
      { return zcount ; }
      
      long getFullZcount() const
         throw() 
      { return (long(getWeek() & 0x3FF) << 19) + getZcount() ; }

      double getTotalZcounts() const
         throw()
      { return double(getWeek()) * ZCOUNT_WEEK + getZcount() ; }

      GPSZcount& setWeek(short inWeek) 
         throw(gpstk::InvalidParameter) ;
      
      GPSZcount& setZcount(long inZcount)
         throw(gpstk::InvalidParameter) ;

      GPSZcount& setFullZcount(long inZcount)
         throw(gpstk::InvalidParameter) ;
      
      GPSZcount& addWeeks(short inWeeks)
         throw(gpstk::InvalidRequest) ;
      
      GPSZcount& addZcounts(long inZcounts)
         throw(gpstk::InvalidRequest) ;

      GPSZcount operator++(int)
         throw(gpstk::InvalidRequest) ;

      GPSZcount& operator++() 
         throw(gpstk::InvalidRequest) ;
      
      GPSZcount operator--(int) 
         throw(gpstk::InvalidRequest) ;

      GPSZcount& operator--() 
         throw(gpstk::InvalidRequest) ;
      
      GPSZcount operator+(long inZcounts) const
         throw(gpstk::InvalidRequest) ;
      
      GPSZcount operator-(long inZcounts) const
         throw(gpstk::InvalidRequest) ;

      double operator-(const GPSZcount& right) const
         throw() ;
      
      long operator%(const long right) const
         throw() ;

      GPSZcount& operator+=(long inZcounts)
         throw(gpstk::InvalidRequest) ;
      
      GPSZcount& operator-=(long inZcounts)
         throw(gpstk::InvalidRequest) ;
      
      GPSZcount& operator=(const GPSZcount& right) 
         throw();
      
      bool operator<(const GPSZcount& right) const
         throw();
      bool operator>(const GPSZcount& right) const
         throw();
      bool operator==(const GPSZcount& right) const
         throw();
      bool operator!=(const GPSZcount& right) const
         throw();
      bool operator<=(const GPSZcount& right) const
         throw();
      bool operator>=(const GPSZcount& right) const
         throw();

      operator std::string() const
         throw() ;

      bool inSameTimeBlock(const GPSZcount& other,
                           unsigned long inZcountBlock,
                           unsigned long inZcountOffset = 0) 
         throw();

      void dump(std::ostream& out,
                short level = 0) const
         throw() ;
      
   protected:
      short week;    
      long zcount;   

      static long validZcount(long z)
         throw();
      
   };
   
   std::ostream& operator<<(std::ostream& s,
                            const gpstk::GPSZcount& z) ;


} // namespace gpstk

#endif // GPSTK_GPSZCOUNT_HPP

---