ConfDataReader.hpp

Go to the documentation of this file.

#pragma ident "$Id: ConfDataReader.hpp 3140 2012-06-18 15:03:02Z susancummins $"

#ifndef CONFDATAREADER_HPP
#define CONFDATAREADER_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., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
//
//  Dagoberto Salazar - gAGE ( http://www.gage.es ). 2008
//
//============================================================================




#include <string>
#include <map>
#include "FFTextStream.hpp"
#include "StringUtils.hpp"
#include "Matrix.hpp"


namespace gpstk
{


   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(); };


      virtual void open(const char* fn);


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


      virtual std::string getValue( std::string variable,
                                    std::string section = "DEFAULT",
                                    std::string defaultVal = "")
         throw(ConfigurationException);


      virtual double getValueAsDouble( std::string variable,
                                       std::string section = "DEFAULT",
                                       double defaultVal = 0.0)
         throw(ConfigurationException)
      { 
         return StringUtils::asDouble( 
               getValue(variable, section, StringUtils::asString(defaultVal)) ); 
      };


      virtual int getValueAsInt( std::string variable,
                                 std::string section = "DEFAULT",
                                 int    defaultVal = 0 )
         throw(ConfigurationException)
      { 
         return StringUtils::asInt( 
                  getValue(variable, section, StringUtils::asString(defaultVal)) ); 
      };


      virtual bool getValueAsBoolean( std::string variable,
                                      std::string section = "DEFAULT", 
                                      bool   defaultVal = false )
         throw(ConfigurationException);


      virtual std::string fetchListValue( std::string variableList,
                                          std::string section = "DEFAULT",
                                          std::string defaultVal = "" )
         throw(ConfigurationException);


      virtual double fetchListValueAsDouble( std::string variableList,
                                             std::string section = "DEFAULT",
                                             double defaultVal = 0.0 )
         throw(ConfigurationException)
      { 
         return StringUtils::asDouble( 
         fetchListValue(variableList,section,StringUtils::asString(defaultVal))); 
      };


      virtual int fetchListValueAsInt( std::string variableList,
                                       std::string section = "DEFAULT",
                                       int    defaultVal = 0 )
         throw(ConfigurationException)
      { 
         return StringUtils::asInt( 
         fetchListValue(variableList,section,StringUtils::asString(defaultVal))); 
      };


      virtual bool fetchListValueAsBoolean( std::string variableList,
                                            std::string section = "DEFAULT",
                                            bool   defaultVal = false)
         throw(ConfigurationException);


      virtual int getNumItem( std::string variableList,
                              std::string section = "DEFAULT" )
         throw(ConfigurationException)
      { return StringUtils::numWords( getValue( variableList, section ) ); };


      virtual std::string getVariableDescription( std::string variable,
                                                  std::string section = "DEFAULT" )
         throw(ConfigurationException);


      virtual std::string getValueDescription( std::string variable,
                                               std::string section = "DEFAULT" )
         throw(ConfigurationException);


      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" )
         throw(ConfigurationException);


      virtual std::string operator()( std::string variable,
                                      std::string section = "DEFAULT" )
         throw(ConfigurationException)
      { 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)
         throw(ConfigurationException);


   }; // End of class 'ConfDataReader'


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

---