view include/IConfig.hpp @ 70:dda89f1d48c6

According to IRC discuss, change the string map to map of string and multimap
author daedric <d43dr1c@gmail.com>
date Wed, 31 Mar 2010 17:00:43 +0200
parents 86584ae719fc
children 7db18b322fba
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
        {
        public:
            typedef std::map < std::string, std::multimap < 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__ */