TimeTag.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_TIMETAG_HPP
#define GNSSTK_TIMETAG_HPP
 
#include "CommonTime.hpp"
#include "TimeSystem.hpp"
#include "TimeSystemConverter.hpp"
#include "StringUtils.hpp"
#include <map>
 
namespace gnsstk
{
 
 
   class TimeTag
   {
   public:
 
      TimeTag()
      {}
 
      TimeTag( const TimeSystem& ts )
      { timeSystem = ts; }
 
      virtual ~TimeTag()
      {}
 
      virtual CommonTime convertToCommonTime() const = 0;
 
      virtual void convertFromCommonTime( const CommonTime& ct ) = 0;
 
      virtual std::string printf( const std::string& fmt ) const = 0;
 
      virtual std::string printError( const std::string& fmt ) const = 0;
 
      virtual void scanf( const std::string& str,
                          const std::string& fmt );
 
      typedef std::map< char, std::string> IdToValue;
 
      static void getInfo( const std::string& str,
                           const std::string& fmt,
                           IdToValue& info );
 
      virtual bool setFromInfo( const IdToValue& info ) = 0;
 
      virtual std::string getPrintChars() const = 0;
 
      virtual std::string getDefaultFormat() const = 0;
 
      virtual bool isValid() const = 0;
 
      virtual void reset() = 0;
 
      virtual std::string asString() const
      { return printf( getDefaultFormat() ); }
 
      virtual operator CommonTime() const
      { return convertToCommonTime(); }
 
      static inline std::string getFormatPrefixInt()
      { return "%[ 0-]?[[:digit:]]*"; }
 
      static inline std::string getFormatPrefixFloat()
      { return getFormatPrefixInt() + "(\\.[[:digit:]]+)?"; }
 
      static inline std::string getError()
      { return "ErrorBadTime"; }
 
      void setTimeSystem( const TimeSystem& timeSys )
      { timeSystem = timeSys; }
 
      TimeSystem getTimeSystem() const
      { return timeSystem ; }
 
      bool changeTimeSystem(TimeSystem timeSys, TimeSystemConverter* conv);
 
      bool changeTimeSystem(TimeSystem timeSys);
 
      static void checkTimeSystem(TimeSystem ts1, TimeSystem ts2);
 
   protected:
 
      TimeSystem timeSystem; 
   };
 
 
} // namespace
 
std::ostream& operator<<( std::ostream& s,
                          const gnsstk::TimeTag& t );
 
#endif // GNSSTK_TIMETAG_HPP