CConfigFile.h

Go to the documentation of this file.

/* +---------------------------------------------------------------------------+
   |                     Mobile Robot Programming Toolkit (MRPT)               |
   |                          http://www.mrpt.org/                             |
   |                                                                           |
   | Copyright (c) 2005-2017, Individual contributors, see AUTHORS file        |
   | See: http://www.mrpt.org/Authors - All rights reserved.                   |
   | Released under BSD License. See details in http://www.mrpt.org/License    |
   +---------------------------------------------------------------------------+ */
#ifndef  CConfigFile_H
#define  CConfigFile_H
 
#include <mrpt/utils/utils_defs.h>
#include <mrpt/utils/CConfigFileBase.h>
#include <mrpt/utils/safe_pointers.h>
 
namespace mrpt
{
namespace utils
{
        /** This class allows loading and storing values and vectors of different types from ".ini" files easily.
          *  The contents of the file will be modified by "write" operations in memory, and will be saved back
          *   to the file at the destructor, and only if at least one write operation has been applied.
          *
          * Use base class `CConfigFileBase`'s methods `read_{int,float,double,string,...}()` and `write()` to actually read and write values.
          *
          * See: \ref config_file_format
          *
          * \ingroup mrpt_base_grp
          */
        class BASE_IMPEXP CConfigFile : public CConfigFileBase
        {
        private:
                std::string             m_file; //!< The name of the file
                void_ptr_noncopy m_ini; //!< The interface to the file:
                bool                    m_modified; //!< If modified since load.
 
        protected:
                /** A virtual method to write a generic string  */
                void  writeString(const std::string &section,const std::string &name, const std::string &str) MRPT_OVERRIDE;
 
                /** A virtual method to read a generic string.
                 * \exception std::exception If the key name is not found and "failIfNotFound" is true. Otherwise the "defaultValue" is returned. */
                std::string  readString(
                        const std::string &section,
                        const std::string &name,
                        const std::string &defaultStr,
                        bool failIfNotFound = false) const MRPT_OVERRIDE;
 
        public:
                /** Constructor that opens a configuration file. */
                CConfigFile( const std::string &fileName );
 
                /** Constructor, does not open any file. You should call "setFileName" before reading or writting or otherwise nothing will be read and write operations will be eventually lost.
                  * However, it's perfectly right to use this object without an associated file, in which case it will behave as an "in-memory" file.
                  */
                CConfigFile();
 
                /** Associate this object with the given file, so future read/write operations will be applied to that file (it's synchronized at destruction) */
                void setFileName(const std::string &fil_path);
 
                /** Dumps the changes to the physical configuration file now, not waiting until destruction. */
                void writeNow();
 
                void discardSavingChanges(); //!< Discard saving (current) changes to physical file upon destruction
 
                /** Returns the file currently open by this object. */
                std::string getAssociatedFile() const { return m_file; }
 
                /** Destructor */
                virtual ~CConfigFile();
 
                /** Returns a list with all the section names. */
                virtual void getAllSections( vector_string      &sections ) const MRPT_OVERRIDE;
 
                /** Returs a list with all the keys into a section. */
                virtual void getAllKeys( const std::string &section, vector_string      &keys ) const MRPT_OVERRIDE;
 
        }; // End of class def.
 
        } // End of namespace
} // end of namespace
#endif