FileHandling/SINEX/SinexBlock.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 3.0 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
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin.
//  Copyright 2004-2020, 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.
//
//==============================================================================

/**
 * @file SinexBlock.hpp
 * Encapsulate SINEX block data, including I/O
 */

#ifndef GPSTK_SINEXBLOCK_HPP
#define GPSTK_SINEXBLOCK_HPP

#include <vector>
#include <map>
#include "SinexBase.hpp"
#include "SinexTypes.hpp"

namespace gpstk
{
   namespace Sinex
   {
         /// @ingroup FileHandling
         //@{

         /** Base class for all SINEX blocks; the common base allows blocks
          * of varying types to be stored in a vector.  Specific block types
          * are realized by the derived Block class defined below.
          */
      class BlockBase
      {
            /* Sinex:Data calls the protected putBlock() and
             * getBlock() methods. */
         friend class Data;

      public:

         virtual ~BlockBase() {}

            /// Comments that apply to an entire block
         std::string  comment;

            /**Returns the block title
             */
         virtual std::string  getTitle() const = 0;

            /** Returns the number of lines in the block
             */
         virtual size_t  getSize() const = 0;

      protected:

            /**
             * Writes the formatted block to the SinexStream.
             * @param s Stream to which to write
             * @returns Number of lines written
             * @throw std::exception
             * @throw FFStreamError
             * @throw StringUtils::StringException
             */
         virtual size_t putBlock(Sinex::Stream& s) const = 0;

            /**
             * Reads a record from the given SinexStream; if an error
             * is encountered in retrieving the record, the stream is reset
             * to its original position and its fail-bit is set.
             * @param s Stream from which to read
             * @returns Number of lines read
             * @throw std::exception
             * @throw StringException when a StringUtils function fails
             * @throw FFStreamError when exceptions(failbit) is set and
             *  a read or formatting error occurs.  This also resets the
             *  stream to its pre-read position.
             */
         virtual size_t getBlock(Sinex::Stream& s) = 0;

      }; // class BlockBase


         /** SINEX block parameterized by the type of data it contains.
          * Each element in the block is a data line of the specified type.
          */
      template<class T>
      class Block : public BlockBase
      {
      public:

         virtual ~Block() {}

         static BlockBase* create() { return new Block<T>; }

         std::string  getTitle() const { return T::BLOCK_TITLE; }

            /** Returns the number of data items in the block
             */
         size_t  getSize() const { return dataVec.size(); }

            /** Appends data to the block
             */
         void push_back(const T& x) { dataVec.push_back(x); }

         std::vector<T>& getData() { return dataVec; }

      protected:

         std::vector<T>  dataVec;  // Data storage

            /** Writes all data in the block to the specified stream
             * @throw std::exception
             * @throw FFStreamError
             */
         virtual size_t putBlock(Sinex::Stream& s) const
         {
            size_t  lineNum = 0;
            typename std::vector<T>::const_iterator  i = dataVec.begin();
            for ( ; i != dataVec.end(); ++i, ++lineNum)
            {
               try
               {
                  const Sinex::DataType&  d = *i;
                  s << (std::string)d << std::endl;
               }
               catch (Exception& exc)
               {
                  FFStreamError  err(exc);
                  GPSTK_THROW(err);
               }
            }
            return lineNum;
         };

            /** Reads all data in a block from the specified stream
             * @throw std::exception
             * @throw FFStreamError
             * @throw StringUtils::StringException
             */
         virtual size_t getBlock(Sinex::Stream& s)
         {
            size_t  lineNum = 0;
            char    c;
            while (s.good() )
            {
               c = s.get();
               if (s.good() )
               {
                  if (c == DATA_START)
                  {
                        /// More data
                     std::string  line;
                     s.formattedGetLine(line);
                     try
                     {
                        dataVec.push_back(
                           T(line.insert( (size_t)0, (size_t)1, c),
                             lineNum) );
                     }
                     catch (Exception& exc)
                     {
                        FFStreamError  err(exc);
                        GPSTK_THROW(err);
                     }
                     ++lineNum;
                  }
                  else
                  {
                        /// End of data
                     s.putback(c);
                     break;
                  }
               }
            }
            return lineNum;
         };

      }; // class Block<T>


         /// Block storage type
      typedef std::vector<const BlockBase*>  Blocks;

         /// Block iterator
      typedef Blocks::iterator  BlockIter;

         /// Function pointer for invoking create methods for blocks
      typedef BlockBase* (*BlockCreateFunc)();

         /// Mapping from block titles to block create functions
      typedef std::map<std::string, BlockCreateFunc>  BlockFactory;

         //@}

   }  // namespace Sinex

}  // namespace gpstk

#endif // GPSTK_SINEXBLOCK_HPP