XmlAttribute.hpp

Go to the documentation of this file.

/*
Copyright 2007, 2008, 2009, 2010, 2011 Instituto de Sistemas e Robotica, Instituto Superior Tecnico

This file is part of MeRMaID.

MeRMaID is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

MeRMaID is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with MeRMaID.  If not, see <http://www.gnu.org/licenses/>.
*/



/**
 * @Filename XmlAttribute.hpp
 * @Description XmlAttribute definition file.
 * @Status Implementing
 * @Version $Id: XmlAttribute.hpp 1 2011-03-04 18:13:18Z jreis $
 * @Maintainer Nelson Ramos (nmsra@mega.ist.utl.pt)
 */

#ifndef __XML_XMLATTRIBUTE_H
#define __XML_XMLATTRIBUTE_H

namespace mermaid
{
  namespace support
  {
    namespace xml
    {
      class XmlAttribute;
    }
  }
}

#include <string>

#include <boost/shared_ptr.hpp>

#include <libxml/parser.h>

namespace mermaid
{
  namespace support
  {
    namespace xml
    {
      using std::string;
      using boost::shared_ptr;
      
      /**
      * @Class XmlAttribute XmlAttribute.hpp "XmlAttribute.hpp"
      * @Description Class representing a XML element's attribute.
      * @Author Marco Barbosa
      */
      class XmlAttribute
      {
          friend class XmlElement;
          
        public:
          /**
          * @Description XmlAttribute name getter
          * @Returns string XmlAttribute's name
          */
          const string getName() const;
          
          /**
          * @Description XmlAttribute value getter
          * @Returns string XmlAttribute's value
          */
          const string getValue() const;
          
        private:
          /**
          * @Description Constructor
          * @Description Builds a new XmlAttribute
          * @Argument attr libxml2 attribute node pointer
          */
          XmlAttribute (xmlAttrPtr attr);
          
          string name_;
          string value_;
      }; // XmlAttribute
    } // namespace xml
  } // namespace support
} // namespace mermaid

#endif // __XML_XMLATTRIBUTE_H