SinexData.cpp

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.
//
//==============================================================================
 
#include "StringUtils.hpp"
#include "SinexStream.hpp"
#include "SinexData.hpp"
#include "SinexTypes.hpp"
 
using namespace gnsstk::StringUtils;
using namespace std;
 
namespace gnsstk
{
namespace Sinex
{
 
   BlockFactory  Data::blockFactory;
 
 
   void
   Data::initBlockFactory()
   {
      if (blockFactory.size() > 0) return;  
 
      blockFactory["FILE/REFERENCE"]         = Block<FileReference>::create;
      blockFactory["FILE/COMMENT"]           = Block<FileComment>::create;
      blockFactory["INPUT/HISTORY"]          = Block<InputHistory>::create;
      blockFactory["INPUT/FILES"]            = Block<InputFile>::create;
      blockFactory["INPUT/ACKNOWLEDGMENTS"]  = Block<InputAck>::create;
      blockFactory["INPUT/ACKNOWLEDGEMENTS"] = Block<InputAck>::create;
      blockFactory["NUTATION/DATA"]          = Block<NutationData>::create;
      blockFactory["PRECESSION/DATA"]        = Block<PrecessionData>::create;
      blockFactory["SOURCE/ID"]              = Block<SourceId>::create;
      blockFactory["SITE/ID"]                = Block<SiteId>::create;
      blockFactory["SITE/DATA"]              = Block<SiteData>::create;
      blockFactory["SITE/RECEIVER"]          = Block<SiteReceiver>::create;
      blockFactory["SITE/ANTENNA"]           = Block<SiteAntenna>::create;
      blockFactory["SITE/GPS_PHASE_CENTER"]  = Block<SiteGpsPhaseCenter>::create;
      blockFactory["SITE/GAL_PHASE_CENTER"]  = Block<SiteGalPhaseCenter>::create;
      blockFactory["SITE/ECCENTRICITY"]      = Block<SiteEccentricity>::create;
      blockFactory["SATELLITE/ID"]           = Block<SatelliteId>::create;
      blockFactory["SATELLITE/PHASE_CENTER"] = Block<SatellitePhaseCenter>::create;
      blockFactory["BIAS/EPOCHS"]            = Block<BiasEpoch>::create;
      blockFactory["SOLUTION/EPOCHS"]        = Block<SolutionEpoch>::create;
      blockFactory["SOLUTION/STATISTICS"]    = Block<SolutionStatistics>::create;
      blockFactory["SOLUTION/ESTIMATE"]      = Block<SolutionEstimate>::create;
      blockFactory["SOLUTION/APRIORI"]       = Block<SolutionApriori>::create;
      blockFactory["SOLUTION/MATRIX_ESTIMATE L CORR"]   = Block<SolutionMatrixEstimateLCorr>::create;
      blockFactory["SOLUTION/MATRIX_ESTIMATE L COVA"]   = Block<SolutionMatrixEstimateLCova>::create;
      blockFactory["SOLUTION/MATRIX_ESTIMATE L INFO"]   = Block<SolutionMatrixEstimateLInfo>::create;
      blockFactory["SOLUTION/MATRIX_ESTIMATE U CORR"]   = Block<SolutionMatrixEstimateUCorr>::create;
      blockFactory["SOLUTION/MATRIX_ESTIMATE U COVA"]   = Block<SolutionMatrixEstimateUCova>::create;
      blockFactory["SOLUTION/MATRIX_ESTIMATE U INFO"]   = Block<SolutionMatrixEstimateUInfo>::create;
      blockFactory["SOLUTION/MATRIX_APRIORI L CORR"]    = Block<SolutionMatrixAprioriLCorr>::create;
      blockFactory["SOLUTION/MATRIX_APRIORI L COVA"]    = Block<SolutionMatrixAprioriLCova>::create;
      blockFactory["SOLUTION/MATRIX_APRIORI L INFO"]    = Block<SolutionMatrixAprioriLInfo>::create;
      blockFactory["SOLUTION/MATRIX_APRIORI U CORR"]    = Block<SolutionMatrixAprioriUCorr>::create;
      blockFactory["SOLUTION/MATRIX_APRIORI U COVA"]    = Block<SolutionMatrixAprioriUCova>::create;
      blockFactory["SOLUTION/MATRIX_APRIORI U INFO"]    = Block<SolutionMatrixAprioriUInfo>::create;
      blockFactory["SOLUTION/NORMAL_EQUATION_VECTOR"]   = Block<SolutionNormalEquationVector>::create;
      blockFactory["SOLUTION/NORMAL_EQUATION_MATRIX L"] = Block<SolutionNormalEquationMatrixL>::create;
      blockFactory["SOLUTION/NORMAL_EQUATION_MATRIX U"] = Block<SolutionNormalEquationMatrixU>::create;
 
   }  // Data::initBlockFactory()
 
 
   Data::~Data()
   {
      BlockIter  i = blocks.begin();
      for ( ; i != blocks.end(); ++i)
      {
         delete (*i);
         *i = NULL;
      }
   } // Data::~Data()
 
 
   void
   Data::reallyPutRecord(FFStream& s) const
   {
      Sinex::Stream& strm = dynamic_cast<Sinex::Stream&>(s);
      try
      {
         strm << (std::string)header << endl;
      }
      catch (Exception& exc)
      {
         FFStreamError  err;
         GNSSTK_THROW(err);
      }
      Blocks::const_iterator  i = blocks.begin();
      for ( ; i != blocks.end(); ++i)
      {
         const BlockBase  *block = *i;
         if (block)
         {
            try
            {
               strm << BLOCK_START << block->getTitle() << endl;
               block->putBlock(strm);
               strm << BLOCK_END << block->getTitle() << endl;
            }
            catch (Exception& exc)
            {
               FFStreamError  err(exc);
               GNSSTK_THROW(err);
            }
         }
      }
      strm << FILE_END << endl;
 
   }  // Data::reallyPutRecord()
 
 
   void
   Data::reallyGetRecord(FFStream& s)
   {
      Sinex::Stream&  strm = dynamic_cast<Sinex::Stream&>(s);
      bool    terminated = false;
      string  currentBlock;
      string  line;
      blocks.clear();
      strm.formattedGetLine(line, true);  
      try
      {
         header = line;
      }
      catch (Exception& exc)
      {
         FFStreamError  err(exc);
         GNSSTK_THROW(err);
      }
      while (strm.good() )
      {
         try
         {
            strm.formattedGetLine(line, true);  
         }
         catch (EndOfFile&  e)
         {
            break;
         }
         if (line.size() < 1)
         {
            FFStreamError err("Invalid empty line.");
            GNSSTK_THROW(err);
         }
         switch (line[0])
         {
            case BLOCK_START:
            {
               if (currentBlock.size() > 0)
               {
                  FFStreamError err("Unexpected start of block.");
                  GNSSTK_THROW(err);
               }
               currentBlock = line.substr(1);
               BlockFactory::iterator i = blockFactory.find(currentBlock);
               if (i == blockFactory.end() )
               {
                  string  errMsg("Invalid block title: ");
                  FFStreamError err(errMsg + currentBlock);
                  GNSSTK_THROW(err);
               }
               BlockCreateFunc  createFunc = i->second;
               BlockBase  *block = createFunc();
               if (block)
               {
                  try
                  {
                     block->getBlock(strm);
                     blocks.push_back(block);
                  }
                  catch (Exception& exc)
                  {
                     FFStreamError  err(exc);
                     GNSSTK_THROW(err);
                  }
               }
               else
               {
                  string  errMsg("Error creating block: ");
                  FFStreamError err(errMsg + currentBlock);
                  GNSSTK_THROW(err);
               }
               break;
            }
            case BLOCK_END:
            {
               if (currentBlock.size() == 0)
               {
                  FFStreamError err("Unexpected end of block.");
                  GNSSTK_THROW(err);
               }
               if (currentBlock.compare(line.substr(1) ) != 0)
               {
                  FFStreamError err("Block start and end do not match.");
                  GNSSTK_THROW(err);
               }
               currentBlock.clear();
               break;
            }
            case DATA_START:
            {
               FFStreamError err("Missing start of block.");
               GNSSTK_THROW(err);
               break;
            }
            case HEAD_TAIL_START:
            {
               if (line.compare("%ENDSNX") == 0)
               {
                  terminated = true;
               }
               else
               {
                  string  errMsg("Invalid line: ");
                  FFStreamError err(errMsg + line);
                  GNSSTK_THROW(err);
               }
               break;
            }
            case COMMENT_START:
            {
               break;
            }
            default:
            {
               string  errMsg("Invalid line start character: ");
               FFStreamError err(errMsg + line[0]);
               GNSSTK_THROW(err);
               break;
            }
 
         }  // switch
      }
      if (currentBlock.size() > 0)
      {
         string  errMsg("Block not properly terminated: ");
         FFStreamError err(errMsg + currentBlock);
         GNSSTK_THROW(err);
      }
      if (!terminated)
      {
         FFStreamError err("File not properly terminated (missing "
                           + FILE_END + " )");
         GNSSTK_THROW(err);
      }
   }  // Data::reallyGetRecord()
 
 
   bool Data::isValidBlockTitle(const std::string& title)
   {
      initBlockFactory();
      BlockFactory::iterator i = blockFactory.find(title);
      return (i == blockFactory.end() ) ? false: true;
 
   }  // Data::isValidBlockTitle()
 
 
   void
   Data::dump(std::ostream& s) const
   {
      Blocks::const_iterator  i = blocks.begin();
      for ( ; i != blocks.end(); ++i)
      {
         const BlockBase  *block = *i;
         if (block)
         {
            s << setw(6) << block->getSize() << " "
              << block->getTitle() << endl;
         }
      }
   }  // Data::dump()
 
}  // namespace Sinex
 
} // namespace gnsstk