XmlElementVector.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 XmlElementVector.hpp
 * @Description XmlElementVector class definition.
 * @Status Implementing
 * @Version $Id: XmlElementVector.hpp 1 2011-03-04 18:13:18Z jreis $
 * @Maintainer Nelson Ramos (nmsra@mega.ist.utl.pt)
 */

// XmlElementVector is used in XmlElement, so it needs to be defined before.
// Including this here will cause XmlElementVector to be defined first.
#include "XmlElement.hpp"

#ifndef __XML_XMLELEMENTVECTOR_H_
#define __XML_XMLELEMENTVECTOR_H_

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

#include <string>





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

#endif // __XML_XMLELEMENTVECTOR_H_