ConfDataReader.hpp

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.
//
//==============================================================================
 
#ifndef CONFDATAREADER_HPP
#define CONFDATAREADER_HPP
 
#include <string>
#include <map>
#include "FFTextStream.hpp"
#include "StringUtils.hpp"
#include "Matrix.hpp"
 
 
namespace gnsstk
{
 
 
 
   class ConfDataReader : public FFTextStream
   {
   public:
 
      ConfDataReader()
         : issueException(true), fallback2Default(false) {};
 
 
      ConfDataReader(const char* file)
         : FFTextStream(file, std::ios::in), issueException(true),
           fallback2Default(false)
      { loadData(); };
 
 
      ConfDataReader(const std::string& file)
         : FFTextStream(file.c_str(), std::ios::in), issueException(true),
           fallback2Default(false)
      { loadData(); };
 
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Woverloaded-virtual"
      virtual void open(const char* fn);
 
 
      virtual void open(const std::string& fn)
      { open( fn.c_str() ); };
#pragma clang diagnostic pop
 
      virtual std::string getValue( std::string variable,
                                    std::string section = "DEFAULT",
                                    std::string defaultVal = "");
 
 
      virtual double getValueAsDouble( std::string variable,
                                       std::string section = "DEFAULT",
                                       double defaultVal = 0.0)
      {
         return StringUtils::asDouble(
               getValue(variable, section, StringUtils::asString(defaultVal)) );
      };
 
 
      virtual int getValueAsInt( std::string variable,
                                 std::string section = "DEFAULT",
                                 int    defaultVal = 0 )
      {
         return StringUtils::asInt(
                  getValue(variable, section, StringUtils::asString(defaultVal)) );
      };
 
 
      virtual bool getValueAsBoolean( std::string variable,
                                      std::string section = "DEFAULT",
                                      bool   defaultVal = false );
 
 
      virtual std::string fetchListValue( std::string variableList,
                                          std::string section = "DEFAULT",
                                          std::string defaultVal = "" );
 
 
      virtual double fetchListValueAsDouble( std::string variableList,
                                             std::string section = "DEFAULT",
                                             double defaultVal = 0.0 )
      {
         return StringUtils::asDouble(
         fetchListValue(variableList,section,StringUtils::asString(defaultVal)));
      };
 
 
      virtual int fetchListValueAsInt( std::string variableList,
                                       std::string section = "DEFAULT",
                                       int    defaultVal = 0 )
      {
         return StringUtils::asInt(
         fetchListValue(variableList,section,StringUtils::asString(defaultVal)));
      };
 
 
      virtual bool fetchListValueAsBoolean( std::string variableList,
                                            std::string section = "DEFAULT",
                                            bool   defaultVal = false);
 
 
      virtual int getNumItem( std::string variableList,
                              std::string section = "DEFAULT" )
      { return StringUtils::numWords( getValue( variableList, section ) ); };
 
 
      virtual std::string getVariableDescription( std::string variable,
                                                  std::string section = "DEFAULT" );
 
 
      virtual std::string getValueDescription( std::string variable,
                                               std::string section = "DEFAULT" );
 
 
      virtual bool getIssueException( void ) const
      { return issueException; };
 
 
      ConfDataReader& setIssueException(bool issueEx)
      { issueException = issueEx; return (*this); }
 
 
      virtual bool getFallback2Default( void ) const
      { return fallback2Default; };
 
 
      ConfDataReader& setFallback2Default(bool fallback)
      { fallback2Default = fallback; return (*this); }
 
 
      virtual ConfDataReader& clear(void)
      { confData.clear(); return (*this); };
 
 
      virtual std::string getEachSection(void);
 
 
      virtual void resetSection(void)
      { itCurrentSection = confData.begin(); return; };
 
 
      virtual bool ifExist( std::string variable,
                            std::string section = "DEFAULT" );
 
 
      virtual std::string operator()( std::string variable,
                                      std::string section = "DEFAULT" )
      { return getValue(variable, section); };
 
 
      virtual ~ConfDataReader() {}
 
 
   private:
 
 
      bool issueException;
 
 
      bool fallback2Default;
 
 
      struct variableData
      {
            // Default constructor initializing the data in the structure
         variableData() : varComment(""), value(""), valueComment("") {};
 
         std::string varComment;      
         std::string value;           
         std::string valueComment;    
      };
 
 
      typedef std::map<std::string, variableData> variableMap;
 
      typedef std::map<std::string, variableMap> confMap;
 
 
 
      confMap confData;
 
 
      confMap::const_iterator itCurrentSection;
 
 
      virtual bool checkName(std::string name);
 
 
      virtual void loadData(void);
 
 
   }; // End of class 'ConfDataReader'
 
 
}  // End of namespace gnsstk
#endif  // CONFDATAREADER_HPP