TimeTag.hpp

Go to the documentation of this file.

#pragma ident "$Id: TimeTag.hpp 1162 2008-03-27 21:18:13Z snelsen $"



#ifndef GPSTK_TIMETAG_HPP
#define GPSTK_TIMETAG_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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//  
//  Copyright 2004, The University of Texas at Austin
//
//============================================================================

#include "CommonTime.hpp"
#include "StringUtils.hpp"
#include <map>

namespace gpstk
{
   class TimeTag
   {
   public:
      
      virtual ~TimeTag() 
         throw()
      {}
      
      virtual CommonTime convertToCommonTime() const
         throw( gpstk::InvalidRequest ) = 0;
      
      virtual void convertFromCommonTime( const CommonTime& ct )
         throw( gpstk::InvalidRequest ) = 0;

      virtual std::string printf( const std::string& fmt ) const
         throw( gpstk::StringUtils::StringException ) = 0;

      virtual std::string printError( const std::string& fmt ) const
         throw( gpstk::StringUtils::StringException ) = 0;

      virtual void scanf( const std::string& str,
                          const std::string& fmt )
         throw( gpstk::InvalidRequest,
                gpstk::StringUtils::StringException );

      typedef std::map< char, std::string> IdToValue;
      
      static void getInfo( const std::string& str,
                           const std::string& fmt,
                           IdToValue& info )
         throw( gpstk::StringUtils::StringException );

      virtual bool setFromInfo( const IdToValue& info )
         throw() = 0;
      
      virtual std::string getPrintChars() const
         throw() = 0;

      virtual std::string getDefaultFormat() const
         throw() = 0;

      virtual bool isValid() const
         throw() = 0;

      virtual void reset()
         throw() = 0;

      virtual std::string asString() const
         throw( gpstk::StringUtils::StringException )
      { return printf( getDefaultFormat() ); }

      virtual operator CommonTime() const
         throw(InvalidRequest)
      { 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"; }

   };

} // namespace

std::ostream& operator<<( std::ostream& s,
                          const gpstk::TimeTag& t );

#endif // GPSTK_BASETIME_HPP

---