CommonTime.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_COMMONTIME_HPP
#define GNSSTK_COMMONTIME_HPP
 
#include "gnsstk_export.h"
#include <memory>
#include "Exception.hpp"
#include "TimeConstants.hpp"
#include "TimeSystem.hpp"
#include "TimeSystemConverter.hpp"
 
namespace gnsstk
{
 
 
   class CommonTime
   {
   public:
 
      GNSSTK_EXPORT static const long BEGIN_LIMIT_JDAY;
      GNSSTK_EXPORT static const long END_LIMIT_JDAY;
 
      GNSSTK_EXPORT static const CommonTime BEGINNING_OF_TIME;
      GNSSTK_EXPORT static const CommonTime END_OF_TIME;
 
      GNSSTK_EXPORT static const double eps;
 
 
      explicit CommonTime(TimeSystem timeSystem = TimeSystem::Unknown )
      { set( 0, 0, 0.0, timeSystem ); }
 
      CommonTime( const CommonTime& right );
 
      CommonTime& operator=( const CommonTime& right );
 
      virtual ~CommonTime()
      {}
 
         //FUTURE DEPRECATION
         //ALL COMMONTIME ACCESSOR/MUTATOR METHODS ARE SET FOR FUTURE DEPRECATION (PRIVATIZATION)
         //Accessor/Mutator methods should only be used by TimeTag classes and not made public,
         //therefore these methods will be deprecated in a future release.
 
          //METHOD SET FOR FUTURE DEPRECATION (PRIVATIZATION)
      CommonTime& set( long day,
                       long sod,
                       double fsod = 0.0,
                       TimeSystem timeSystem = TimeSystem::Unknown );
 
          //METHOD SET FOR FUTURE DEPRECATION (PRIVATIZATION)
      CommonTime& set( long day,
                       double sod = 0.0,
                       TimeSystem timeSystem = TimeSystem::Unknown );
 
          //METHOD SET FOR FUTURE DEPRECATION (PRIVATIZATION)
      CommonTime& set( double day,
                       TimeSystem timeSys = TimeSystem::Unknown );
 
          //METHOD SET FOR FUTURE DEPRECATION (PRIVATIZATION)
      CommonTime& setInternal( long day = 0,
                               long msod = 0,
                               double fsod = 0.0,
                               TimeSystem timeSys = TimeSystem::Unknown );
 
          //METHOD SET FOR FUTURE DEPRECATION (PRIVATIZATION)
      CommonTime& setTimeSystem( TimeSystem timeSystem )
      { m_timeSystem = timeSystem; return *this; }
 
      bool changeTimeSystem(TimeSystem timeSystem, TimeSystemConverter* conv);
 
      bool changeTimeSystem(TimeSystem timeSystem);
 
          //METHOD SET FOR FUTURE DEPRECATION (PRIVATIZATION)
      void get( long& day,
                long& sod,
                double& fsod,
                TimeSystem& timeSystem ) const;
 
          //METHOD SET FOR FUTURE DEPRECATION (PRIVATIZATION)
      void get( long& day,
                long& sod,
                double& fsod ) const;
 
          //METHOD SET FOR FUTURE DEPRECATION (PRIVATIZATION)
      void get( long& day,
                double& sod,
                TimeSystem& timeSystem ) const;
 
          //METHOD SET FOR FUTURE DEPRECATION (PRIVATIZATION)
      void get( long& day,
                double& sod ) const;
 
          //METHOD SET FOR FUTURE DEPRECATION (PRIVATIZATION)
      void get( double& day,
                TimeSystem& timeSystem ) const;
 
          //METHOD SET FOR FUTURE DEPRECATION (PRIVATIZATION)
      void get( double& day ) const;
 
          //METHOD SET FOR FUTURE DEPRECATION (PRIVATIZATION)
      void getInternal( long& day,
                        long& msod,
                        double& fsod,
                        TimeSystem& timeSystem ) const
      { day = m_day; msod = m_msod; fsod = m_fsod; timeSystem = m_timeSystem; }
 
          //METHOD SET FOR FUTURE DEPRECATION (PRIVATIZATION)
      void getInternal( long& day,
                        long& msod,
                        double& fsod ) const
      { day = m_day; msod = m_msod; fsod = m_fsod; }
 
          //METHOD SET FOR FUTURE DEPRECATION (PRIVATIZATION)
      double getDays() const;
 
          //METHOD SET FOR FUTURE DEPRECATION (PRIVATIZATION)
      double getSecondOfDay() const;
 
          //METHOD SET FOR FUTURE DEPRECATION (PRIVATIZATION)
      TimeSystem getTimeSystem() const;
 
 
      double operator-( const CommonTime& right ) const;
 
      CommonTime operator+( double seconds ) const;
 
      CommonTime operator-( double seconds ) const;
 
      CommonTime& operator+=( double seconds );
 
      CommonTime& operator-=( double seconds );
 
      CommonTime& addSeconds( double seconds );
 
      CommonTime& addDays( long days );
 
      CommonTime& addSeconds( long seconds );
 
      CommonTime& addMilliseconds( long ms );
 
      bool operator==( const CommonTime& right ) const;
      bool operator!=( const CommonTime& right ) const;
      bool operator<( const CommonTime& right ) const;
      bool operator>( const CommonTime& right ) const;
      bool operator<=( const CommonTime& right ) const;
      bool operator>=( const CommonTime& right ) const;
 
      void reset()
      { m_day = m_msod = 0; m_fsod = 0.0; m_timeSystem = TimeSystem::Unknown; }
 
      std::string asString() const;
 
      GNSSTK_EXPORT static std::shared_ptr<TimeSystemConverter> tsConv;
 
   protected:
 
      CommonTime( long day,
                  long sod,
                  double fsod,
                  TimeSystem timeSystem = TimeSystem::Unknown )
      { set( day, sod, fsod, timeSystem ); }
 
      bool add( long days,
                long msod,
                double fsod );
 
      bool normalize();
 
      long m_day;
      long m_msod;    
      double m_fsod;  
 
      TimeSystem m_timeSystem; 
 
   }; // end class CommonTime
 
   std::ostream& operator<<(std::ostream& o, const CommonTime& ct);
 
 
} // namespace
 
#endif // GNSSTK_COMMONTIME_HPP