CivilTime.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_CIVILTIME_HPP
#define GNSSTK_CIVILTIME_HPP
 
#include "TimeTag.hpp"
#include "TimeSystem.hpp"
 
namespace gnsstk
{
 
 
   class CivilTime : public TimeTag
   {
   public:
 
      CivilTime( int yr = 0,
                 int mo = 0,
                 int dy = 0,
                 int hr = 0,
                 int mn = 0,
                 double s = 0.0,
                 const TimeSystem& ts = TimeSystem::Unknown )
            : year(yr), month(mo), day(dy), hour(hr), minute(mn), second(s)
      { timeSystem = ts; }
 
      CivilTime( const CivilTime& right )
            : year( right.year ), month( right.month )  , day( right.day ),
              hour( right.hour ), minute( right.minute ), second( right.second )
      { timeSystem = right.timeSystem; }
 
      CivilTime( const TimeTag& right )
      {
         convertFromCommonTime( right.convertToCommonTime() );
      }
 
      CivilTime( const CommonTime& right )
      {
         convertFromCommonTime( right );
      }
 
      CivilTime& operator=( const CivilTime& right );
 
      virtual ~CivilTime()
      {}
 
      static const char *MonthNames[];
 
      static const char *MonthAbbrevNames[];
 
         // The following functions are required by TimeTag.
      virtual CommonTime convertToCommonTime() const;
 
      virtual void convertFromCommonTime( const CommonTime& ct );
 
      virtual std::string printf(const std::string& fmt) const;
 
      virtual std::string printError( const std::string& fmt) const;
 
      virtual bool setFromInfo( const IdToValue& info );
 
      virtual std::string getPrintChars() const
      {
         return "YymbBdHMSfP";
      }
 
      virtual std::string getDefaultFormat() const
      {
         return "%02m/%02d/%04Y %02H:%02M:%02S %P";
      }
 
      virtual bool isValid() const;
 
      virtual void reset();
 
      static int monthAbbrev(const std::string& amonStr);
 
      static int monthLong(const std::string& monStr);
 
      bool operator==( const CivilTime& right ) const;
      bool operator!=( const CivilTime& right ) const;
      bool operator<( const CivilTime& right ) const;
      bool operator>( const CivilTime& right ) const;
      bool operator<=( const CivilTime& right ) const;
      bool operator>=( const CivilTime& right ) const;
 
      double getUTHour() const
      { return (double)hour + (((minute*60.0)+second)/3600.0); }
 
      int year;
      int month;
      int day;
      int hour;
      int minute;
      double second;
 
   };
 
} // namespace
 
   // -----------CivilTime operator<< -----------
   //
std::ostream& operator<<( std::ostream& s,
                          const gnsstk::CivilTime& cit );
 
#endif // GNSSTK_CIVILTIME_HPP