UnixTime.cpp

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.
//
//==============================================================================
 
 
#include "UnixTime.hpp"
#include "TimeConstants.hpp"
 
namespace gnsstk
{
   UnixTime& UnixTime::operator=( const UnixTime& right )
   {
      tv.tv_sec  = right.tv.tv_sec ;
      tv.tv_usec = right.tv.tv_usec;
      timeSystem = right.timeSystem;
      return *this;
   }
 
   CommonTime UnixTime::convertToCommonTime() const
   {
      try
      {
         CommonTime ct;
         return ct.set( ( MJD_JDAY + UNIX_MJD + tv.tv_sec / SEC_PER_DAY ),
                        ( tv.tv_sec % SEC_PER_DAY ),
                        ( static_cast<double>( tv.tv_usec ) * 1e-6 ),
                        timeSystem );
      }
      catch (InvalidParameter& ip)
      {
         InvalidRequest ir(ip);
         GNSSTK_THROW(ip);
      }
   }
 
   void UnixTime::convertFromCommonTime( const CommonTime& ct )
   {
      static const CommonTime MIN_CT = UnixTime(0, 0, TimeSystem::Any);
      static const CommonTime MAX_CT = UnixTime(2147483647, 999999,
                                                TimeSystem::Any);
 
         // Only check the min/max range if we're using 32-bit time_t.
         // If we're using 64-bit, the time range of struct timeval
         // will be well beyond what CommonTime can represent.
      if ((sizeof(tv.tv_sec) <= 4) && ((ct < MIN_CT) || (ct > MAX_CT)))
      {
         InvalidRequest ir("Unable to convert given CommonTime to UnixTime.");
         GNSSTK_THROW(ir);
      }
 
      long jday, sod;
      double fsod;
      ct.get( jday, sod, fsod, timeSystem );
 
      tv.tv_sec = (jday - MJD_JDAY - UNIX_MJD) * SEC_PER_DAY + sod;
 
         // round to the nearest microsecond
      tv.tv_usec = static_cast<time_t>( fsod * 1e6 + 0.5 ) ;
 
      if (tv.tv_usec >= 1000000)
      {
         tv.tv_usec -= 1000000;
         ++tv.tv_sec;
      }
   }
 
   std::string UnixTime::printf( const std::string& fmt ) const
   {
      try
      {
         using gnsstk::StringUtils::formattedPrint;
         std::string rv( fmt );
 
         rv = formattedPrint(rv, getFormatPrefixInt() + "U",
                             "Ulu", tv.tv_sec);
         rv = formattedPrint(rv, getFormatPrefixInt() + "u",
                             "ulu", tv.tv_usec);
         rv = formattedPrint(rv, getFormatPrefixInt() + "P",
                             "Ps", StringUtils::asString(timeSystem).c_str() );
         return rv;
      }
      catch( gnsstk::StringUtils::StringException& se )
      {
         GNSSTK_RETHROW( se );
      }
   }
 
   std::string UnixTime::printError( const std::string& fmt ) const
   {
      try
      {
         using gnsstk::StringUtils::formattedPrint;
         std::string rv( fmt );
 
         rv = formattedPrint(rv, getFormatPrefixInt() + "U",
                             "Us", getError().c_str());
         rv = formattedPrint(rv, getFormatPrefixInt() + "u",
                             "us", getError().c_str());
         rv = formattedPrint( rv, getFormatPrefixInt() + "P",
                             "Ps", getError().c_str());
         return rv;
      }
      catch( gnsstk::StringUtils::StringException& se )
      {
         GNSSTK_RETHROW( se );
      }
   }
 
   bool UnixTime::setFromInfo( const IdToValue& info )
   {
      using namespace gnsstk::StringUtils;
 
      for( IdToValue::const_iterator i = info.begin(); i != info.end(); i++ )
      {
         switch( i->first )
         {
            case 'U':
               tv.tv_sec = asInt( i->second );
               break;
 
            case 'u':
               tv.tv_usec = asInt( i->second );
               break;
 
            case 'P':
               timeSystem = gnsstk::StringUtils::asTimeSystem(i->second);
               break;
 
            default:
                  // do nothing
               break;
         };
      }
 
      return true;
   }
 
   bool UnixTime::isValid() const
   {
      UnixTime temp;
      temp.convertFromCommonTime( convertToCommonTime() );
      if( *this == temp )
      {
         return true;
      }
      return false;
   }
 
   void UnixTime::reset()
   {
      tv.tv_sec = tv.tv_usec = 0;
      timeSystem = TimeSystem::Unknown;
   }
 
   bool UnixTime::operator==( const UnixTime& right ) const
   {
      if ((timeSystem != TimeSystem::Any &&
           right.timeSystem != TimeSystem::Any) &&
          timeSystem != right.timeSystem)
         return false;
 
      if( tv.tv_sec == right.tv.tv_sec  &&
          abs(tv.tv_usec - right.tv.tv_usec) < CommonTime::eps )
      {
         return true;
      }
      return false;
   }
 
   bool UnixTime::operator!=( const UnixTime& right ) const
   {
      return ( !operator==( right ) );
   }
 
   bool UnixTime::operator<( const UnixTime& right ) const
   {
      if ((timeSystem != TimeSystem::Any &&
           right.timeSystem != TimeSystem::Any) &&
          timeSystem != right.timeSystem)
      {
         gnsstk::InvalidRequest ir("CommonTime objects not in same time system, cannot be compared");
         GNSSTK_THROW(ir)
      }
 
      if( tv.tv_sec  <  right.tv.tv_sec )
      {
         return true;
      }
      if( tv.tv_sec  == right.tv.tv_sec  &&
          tv.tv_usec <  right.tv.tv_usec   )
      {
         return true;
      }
      return false;
   }
 
   bool UnixTime::operator>( const UnixTime& right ) const
   {
      return ( !operator<=( right ) );
   }
 
   bool UnixTime::operator<=( const UnixTime& right ) const
   {
      return ( operator<( right ) ||
               operator==( right ) );
   }
 
   bool UnixTime::operator>=( const UnixTime& right ) const
   {
      return ( !operator<( right ) );
   }
 
} // namespace