view include/IConfig.hpp @ 42:1254fa6755a3

Fix doxygen doc generation
author Louis Opter <kalessin@kalessin.fr>
date Mon, 22 Mar 2010 13:46:08 +0100
parents 7c8cd74023ce
children dad671a5f028
line wrap: on
line source

#ifndef __ZIA_API_ICONFIG_HPP__
# define __ZIA_API_ICONFIG_HPP__

# include <map>
# include <string>

namespace   zia
{
    namespace   api
    {
        /**
         * @brief Represent the interface that the configuration handler has to
         * respect to interact with 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 will be required.
             *
             * @return the map of key/value found in configuration file.
             */
            virtual const ValueMap &    getEntries(void) const = 0;
        };
    };
};

#endif	/* ! __ZIA_API_ICONFIG_HPP__ */