CivilTime.hpp

Go to the documentation of this file.

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

#ifndef GPSTK_CIVILTIME_HPP
#define GPSTK_CIVILTIME_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 "TimeTag.hpp"
#include "TimeSystem.hpp"

namespace gpstk
{
   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,
                 TimeSystem ts = TimeSystem::Unknown )
         throw()
            : year(yr), month(mo), day(dy), hour(hr), minute(mn), second(s)
      { timeSystem = ts; }
      
      CivilTime( const CivilTime& right )
         throw()
            : 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 )
         throw()
      {
         convertFromCommonTime( right.convertToCommonTime() ); 
      }
     
      CivilTime( const CommonTime& right )
         throw()
      {
         convertFromCommonTime( right );
      }

      CivilTime& operator=( const CivilTime& right )
         throw();

      virtual ~CivilTime() 
         throw()
      {}

      static const char *MonthNames[];
      
      static const char *MonthAbbrevNames[];
      
         // The following functions are required by TimeTag.
      virtual CommonTime convertToCommonTime() const
         throw( gpstk::InvalidRequest );

      virtual void convertFromCommonTime( const CommonTime& ct )
         throw();
      
      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();

      virtual std::string getPrintChars() const
         throw()
      { 
         return "YymbBdHMSfP";
      }

      virtual std::string getDefaultFormat() const
         throw()
      {
         return "%02m/%02d/%04Y %02H:%02M:%02S %P";
      }

      virtual bool isValid() const
         throw();

      virtual void reset() 
         throw();

      bool operator==( const CivilTime& right ) const
         throw();
      bool operator!=( const CivilTime& right ) const
         throw();
      bool operator<( const CivilTime& right ) const
         throw( gpstk::InvalidRequest );
      bool operator>( const CivilTime& right ) const
         throw( gpstk::InvalidRequest );
      bool operator<=( const CivilTime& right ) const
         throw( gpstk::InvalidRequest );
      bool operator>=( const CivilTime& right ) const
         throw( gpstk::InvalidRequest );

      int year;
      int month;
      int day;
      int hour;
      int minute;
      double second;

   };

      // -----------CivilTime operator<< -----------
      //
   std::ostream& operator<<( std::ostream& s,
                             const gpstk::CivilTime& cit );

} // namespace

#endif // GPSTK_CIVILTIME_HPP

---