FFTextStream.hpp

Go to the documentation of this file.

#pragma ident "$Id: FFTextStream.hpp 2559 2011-04-18 21:12:23Z architest $"

#ifndef GPSTK_FFTEXTSTREAM_HPP
#define GPSTK_FFTEXTSTREAM_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
//
//============================================================================

//============================================================================
//
//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 "FFStream.hpp"

namespace gpstk
{


   class FFTextStream : public FFStream
   {
   public:


      virtual ~FFTextStream() {};


      FFTextStream()
            : lineNumber(0) {};


      FFTextStream( const char* fn,
                    std::ios::openmode mode=std::ios::in )
         : FFStream(fn, mode), lineNumber(0)
      {};


      FFTextStream( const std::string& fn,
                    std::ios::openmode mode=std::ios::in )
         : FFStream( fn.c_str(), mode ), lineNumber(0)
      {};


      virtual void open( const char* fn,
                         std::ios::openmode mode )
      { FFStream::open(fn, mode); lineNumber = 0; };


      virtual void open( const std::string& fn,
                         std::ios::openmode mode )
      { open(fn.c_str(), mode); };


      unsigned int lineNumber;


      inline void formattedGetLine( std::string& line,
                                    const bool expectEOF = false )
         throw(EndOfFile, FFStreamError, gpstk::StringUtils::StringException);


   protected:


      virtual void tryFFStreamGet(FFData& rec)
         throw(FFStreamError, gpstk::StringUtils::StringException)
      {

         unsigned int initialLineNumber = lineNumber;

         try
         {
            FFStream::tryFFStreamGet(rec);
         }
         catch(gpstk::Exception& e)
         {
            e.addText( std::string("Near file line ") +
                       gpstk::StringUtils::asString(lineNumber) );
            lineNumber = initialLineNumber;
            mostRecentException = e;
            conditionalThrow();
         }

       };


      virtual void tryFFStreamPut(const FFData& rec)
         throw(FFStreamError, gpstk::StringUtils::StringException)
      {

         unsigned int initialLineNumber = lineNumber;

         try
         {
            FFStream::tryFFStreamPut(rec);
         }
         catch(gpstk::Exception& e)
         {
            e.addText( std::string("Near file line ") +
                       gpstk::StringUtils::asString(lineNumber) );
            lineNumber = initialLineNumber;
            mostRecentException = e;
            conditionalThrow();
         }

      }

   }; // End of class 'FFTextStream'



      // the reason for checking ffs.eof() in the try AND catch block is
      // because if the user enabled exceptions on the stream with exceptions()
      // then eof could throw an exception, in which case we need to catch it
      // and rethrow an EOF or FFStream exception.  In any event, EndOfFile
      // gets thrown whenever there's an EOF and expectEOF is true
   void FFTextStream::formattedGetLine( std::string& line,
                                        const bool expectEOF )
         throw(EndOfFile, FFStreamError, gpstk::StringUtils::StringException)
   {

      try
      {
            // The following constant used to be 256, but with the change to
            // RINEX3 formats the possible length of a line increased
            // considerably. A RINEX3 observation file line for Galileo may
            // be 1277 characters long (taking into account all the possible
            // types of observations available, plus the end of line
            // characters), so this constant was conservatively set to
            // 1500 characters. Dagoberto Salazar.
         const int MAX_LINE_LENGTH = 1500;
         char templine[MAX_LINE_LENGTH + 1];
         getline(templine, MAX_LINE_LENGTH);
         lineNumber++;
            //check if line was longer than 256 characters, if so error
         if(fail() && !eof())
         {
            FFStreamError err("Line too long");
            GPSTK_THROW(err);
         }
         line = templine;
         gpstk::StringUtils::stripTrailing(line, '\r');
            // catch EOF when stream exceptions are disabled
         if ((gcount() == 0) && eof())
         {
            if (expectEOF)
            {
               EndOfFile err("EOF encountered");
               GPSTK_THROW(err);
            }
            else
            {
               FFStreamError err("Unexpected EOF encountered");
               GPSTK_THROW(err);
            }
         }
      }
      catch(std::exception &e)
      {

            // catch EOF when exceptions are enabled
         if ( (gcount() == 0) && eof())
         {
            if (expectEOF)
            {
               EndOfFile err("EOF encountered");
               GPSTK_THROW(err);
            }
            else
            {
               FFStreamError err("Unexpected EOF");
               GPSTK_THROW(err);
            }
         }
         else
         {
            FFStreamError err("Critical file error: " +
                              std::string(e.what()));
            GPSTK_THROW(err);
         }  // End of 'if ( (gcount() == 0) && eof())'

      }  // End of 'try-catch' block

   }  // End of method 'FFTextStream::formattedGetLine()'


}  // End of namespace gpstk
#endif   // GPSTK_FFTEXTSTREAM_HPP

---