GPSWeekZcount.hpp

Go to the documentation of this file.

#pragma ident "$Id: GPSWeekZcount.hpp 3140 2012-06-18 15:03:02Z susancummins $"



#ifndef GPSTK_GPSWEEKZCOUNT_HPP
#define GPSTK_GPSWEEKZCOUNT_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., 51 Franklin Street, Fifth Floor, Boston, MA 02110, 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.
//
//=============================================================================

#include "GPSWeek.hpp"
#include "TimeConstants.hpp"
#include "TimeSystem.hpp"

namespace gpstk
{
   class GPSWeekZcount : public GPSWeek
   {
   public:
      static const unsigned int bits19 = 0x7FFFF;

      GPSWeekZcount( int w = 0,
                     int z = 0,
                     TimeSystem ts = TimeSystem::Unknown )
         throw()
            : GPSWeek( w ), zcount( z )
      { timeSystem = ts; }
      
      GPSWeekZcount( const GPSWeekZcount& right )
         throw()
            : GPSWeek( right.week ), zcount( right.zcount )
      { timeSystem = right.timeSystem; }
      
      GPSWeekZcount( const TimeTag& right )
         throw( gpstk::InvalidRequest )
      { 
         convertFromCommonTime( right.convertToCommonTime() ); 
      }
      
      GPSWeekZcount( const CommonTime& right )
         throw( gpstk::InvalidRequest )
      {
         convertFromCommonTime( right );
      }

      GPSWeekZcount& operator=( const GPSWeekZcount& right )
         throw();
      
      virtual ~GPSWeekZcount()
         throw()
      {}

         // The following functions are required by TimeTag.
      virtual CommonTime convertToCommonTime() const
         throw( gpstk::InvalidRequest );

      virtual void convertFromCommonTime( const CommonTime& ct )
         throw( gpstk::InvalidRequest );

      virtual std::string printf( const std::string& fmt ) const
         throw( gpstk::StringUtils::StringException );

      virtual std::string printError( const std::string& fmt) const
         throw( gpstk::StringUtils::StringException );

      virtual bool setFromInfo( const IdToValue& info )
         throw();
      
      inline virtual std::string getPrintChars() const
         throw()
      { 
         return GPSWeek::getPrintChars() + "wzZcC";
      }

      inline virtual std::string getDefaultFormat() const
         throw()
      {
         return GPSWeek::getDefaultFormat() + " %06Z %P";
      }

      virtual bool isValid() const
         throw()
      {
         return ( GPSWeek::isValid() &&
                 zcount < ZCOUNT_PER_WEEK );
      }
      
      inline virtual void reset()
         throw()
      {
         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)
         throw();

      GPSWeekZcount& setZcount32(unsigned int z)
         throw();

      inline virtual unsigned int getDayOfWeek() const
         throw()
      {
         return static_cast<unsigned int>(zcount) / ZCOUNT_PER_DAY;
      }

     //
       inline bool operator==( const GPSWeekZcount& right ) const
         throw()
       {
          return ( GPSWeek::operator==(right) &&
                   zcount == right.zcount );
       }
   
       inline bool operator!=( const GPSWeekZcount& right ) const
         throw()
       {
          return ( !operator==( right ) );
       }

       inline bool operator<( const GPSWeekZcount& right ) const
         throw()
       {
         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
         throw()
       {
         return ( !operator<=( right ) );
       }

       inline bool operator<=( const GPSWeekZcount& right ) const
         throw()
       {
         return ( operator<( right ) ||
                  operator==( right ) );
       }

       inline bool operator>=( const GPSWeekZcount& right ) const
         throw()
       { 
         return ( !operator<( right ) );
       }

      unsigned int zcount;
   };   
   
} // namespace

#endif // GPSTK_GPSWEEKZCOUNT_HPP

---