BLQDataReader.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 "BLQDataReader.hpp"
 
 
 
namespace gnsstk
{
 
      // Method to store load ocean tide harmonics data in this class'
      // data map
   void BLQDataReader::loadData(void)
   {
 
         // Counter of valid data lines
      int row(0);
 
         // We will store here the station name
      std::string nameString("");
 
         // Declare structure to store tide harmonics data
      BLQDataReader::tideData data;
 
         // Do this until end-of-file reached or something else happens
      while(1)
      {
 
         try
         {
 
            if(row>6)
            {
                  // If row>6, all station harmonics are already read,
                  // so let's store tide data in data map
               setData(nameString, data);
 
                  // Clear harmonics data
               data.harmonics.resize(6,11,0.0);
 
                  // Reset counter to get data from an additional station
               row = 0;
            }
 
            std::string line;
 
            formattedGetLine(line, true);
 
               // If line is too long, we throw an exception
            if (line.size()>255)
            {
               FFStreamError e("Line too long");
               GNSSTK_THROW(e);
            }
 
               // Let's find and strip comments, wherever they are
            if( StringUtils::firstWord(line)[0] == '$' )
            {
               formattedGetLine(line, true);
            }
 
            std::string::size_type idx = line.find('$');
            if( !(idx == std::string::npos) )
            {
               line = line.substr(0, idx);
            }
 
               // Remove trailing and leading blanks
            line = StringUtils::strip(line);
 
               // Skip blank lines
            if (line.size()==0)
            {
               continue;
            }
 
               // Let's start to get data out of file
               // If this is the first valid line, it contains station name
            if (row==0)
            {
 
               nameString =
                  StringUtils::upperCase(StringUtils::stripFirstWord(line));
 
               ++row;
 
               continue;
 
            }
            else
            {
 
                  // 2nd to 7th valid lines contains tide harmonics
               if ( (row>0) && (row<=6) )
               {
                  for(int col=0; col<11; col++)
                  {
                     std::string value(StringUtils::stripFirstWord(line));
                     data.harmonics((row-1),col) = StringUtils::asDouble(value);
                  }
                  ++row;
                  continue;
               }
            }
 
         }  // End of try block
         catch (EndOfFile& e)
         {
 
               // We should close this data stream before returning
            (*this).close();
 
            return;
         }
         catch (...)
         {
 
               // We should close this data stream before returning
            (*this).close();
 
            return;
 
         }
 
      }  // End of 'while(1)...'
 
   }  // End of method 'BLQDataReader::loadData()'
 
 
 
      // Method to open AND load ocean tide harmonics data file. It doesn't
      // clear data previously loaded.
   void BLQDataReader::open(const char* fn)
   {
 
         // We need to be sure current data stream is closed
      (*this).close();
 
         // Open data stream
      FFTextStream::open(fn, std::ios::in);
      loadData();
 
      return;
   }  // End of method 'BLQDataReader::open()'
 
 
 
      // Method to open AND load ocean tide harmonics data file. It doesn't
      // clear data previously loaded.
   void BLQDataReader::open(const std::string& fn)
   {
 
         // We need to be sure current data stream is closed
      (*this).close();
 
         // Open data stream
      FFTextStream::open(fn.c_str(), std::ios::in);
      loadData();
 
      return;
   }  // End of method 'BLQDataReader::open()'
 
 
 
      /* Method to get the ocean tide harmonics corresponding to a
       * given station.
       *
       * @param station   Station name (case is NOT relevant).
       *
       * @return A Matrix<double> of siw rows and eleven columns
       * containing tide harmonics M2, S2, N2, K2, K1, O1, P1, Q1, MF,
       * MM and SSA for amplitudes (radial, west, south, in meters) and
       * phases (radial, west, south, in degrees). If station is
       * not found, this method will return a matrix full of zeros.
       */
   Matrix<double> BLQDataReader::getTideHarmonics(const std::string& station)
   {
 
         // First, look if such station exist in data map
      tideDataIt iter( OceanTidesData.find( StringUtils::upperCase(station) ) );
      if ( iter != OceanTidesData.end() )
      {
            // if found, return corresponding harmonics matrix
         return (*iter).second.harmonics;
      }
      else
      {
            // If not, return an empty harmonics matrix
         Matrix<double> dummy(6,11,0.0);
         return dummy;
      };
 
   }  // End of method 'BLQDataReader::getTideHarmonics()'
 
 
 
}  // End of namespace gnsstk