view include/IConfig.hpp @ 53:e16869cd9773

Minor fixes, improve doxygen doc main page, add a CHANGELOG file
author Louis Opter <kalessin@kalessin.fr>
date Thu, 25 Mar 2010 21:36:16 +0100
parents dad671a5f028
children 86584ae719fc
line wrap: on
line source

#ifndef __ZIA_API_ICONFIG_HPP__
# define __ZIA_API_ICONFIG_HPP__

# include <map>
# include <string>

namespace   zia
{
    namespace   api
    {
        /**
         * @brief Represents the interface that the configuration handler must
         * respect to interact with a module.
         */
        class   IConfig
        {
            typedef std::map<std::string, std::string>  ValueMap;

            virtual ~IConfig(void) { }

            /**
             * @brief Get the configuration entries.
             *
             * At the moment we return a map of strings. We will see if more
             * complex data structure is required.
             *
             * @return the map of key/value found in configuration file.
             */
            virtual const ValueMap &    getEntries(void) const = 0;
        };
    };
};

#endif	/* ! __ZIA_API_ICONFIG_HPP__ */