Properties.h

Go to the documentation of this file.

#ifndef PROPERTIES_H
#define PROPERTIES_H

#include <map>
#include <string>
#include <vector>
#include <memory>
#include <stdexcept>

namespace acsalarm
{
        typedef std::map< std::string, std::string >::value_type PropertyMapEntryType;

        /*
         * Utility class containing a collection of properties, which are name/value pairs of strings.
         */
        class Properties
        {
                private:

                        std::map<std::string, std::string> propertiesMap;

                public:

                        // constructors
                        Properties();
                        Properties(const Properties &);

                        // destructor
                        virtual ~Properties();

                        // assignment operator
                        Properties & operator=(const Properties & rhs);

                        // equality operator
                        bool operator==(const Properties &rhs) ;

                        // operator !=
                        bool operator!=(const Properties &rhs) ;

                        std::string getProperty(std::string key) const;

                        // Returns an enumeration of all the keys in this property list, 
                        // including distinct keys in the default property list if a key 
                        // of the same name has not already been found from the main properties list.
                        std::auto_ptr<std::vector<std::string> > propertyNames();

                        void setProperty(std::string key, std::string value) throw(std::invalid_argument);

                        // Returns an XML fragment (NOT a complete document) representing all of 
                        // the properties contained in this table, for use in the message transported
                        // from an alarm source to the alarm server.
                        // @param amountToIndent - used to specify a level of indentation (in spaces) for readability
                        std::string toXML(int amountToIndent = 6);

                        unsigned int getSize() const { return propertiesMap.size(); }
        };
}
#endif