XmlAttributeVector.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 XmlAttributeVector.hpp
 * @Description XmlAttributeVector class definition.
 * @Status Implementing
 * @Version $Id: XmlAttributeVector.hpp 1 2011-03-04 18:13:18Z jreis $
 * @Maintainer
 */

#ifndef __XML_XMLATTRIBUTEVECTOR_H_
#define __XML_XMLATTRIBUTEVECTOR_H_

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

#include <string>
#include <vector>



#include "XmlAttribute.hpp"



namespace mermaid
{
  namespace support
  {
    namespace xml
    {
      using std::string;
      using std::vector;
      
      using boost::shared_ptr;
      
      /**
       * @Class XmlAttributeVector XmlAttributeVector.hpp "XmlAttributeVector.hpp"
       * @Description Class representing an XML Attribute vector.
       * @Author Marco Barbosa
       */
      class XmlAttributeVector : public vector< shared_ptr<XmlAttribute> >
      {
        public:
          /**
           * @Description Generates an XmlAttributeVector that is a subset of
           * @Description the current one. The XmlAttributes inside the
           * @Description resulting XmlAttributeVector have their name equal
           * @Description to the string passed as argument.
           * @Argument name The name of the desired XmlAttributes
           * @Returns The resulting XmlAttributeVector
           */
          XmlAttributeVector getAttributesWithName (string name);
          
          /**
           * @Description Gets the first XmlAttribute that has the name
           * @Description equal to the string passed as argument.
           * @Argument name The name of the desired XmlAttribute
           * @Returns The desired XmlAttribute or NULL if it doesn't exist
           */
          shared_ptr<XmlAttribute> getFirstAttributeWithName (string name);
      }; // class XmlElementVector
    } // namespace xml
  } // namespace support
} // namespace mermaid

#endif // __XML_XMLELEMENTVECTOR_H_