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

#ifndef __XML_XMLITEM_H_
#define __XML_XMLITEM_H_

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

#include <string>
#include <vector>

#include <Stringable.hpp>



namespace mermaid
{
  namespace support
  {
    namespace xml
    {
      using std::string;
      using std::vector;
      
      using mermaid::support::syntacticsugar::Stringable;
      
      typedef vector<XmlItem*> XmlItemVector; ///< Vector of XmlItem's
      
      /**
      * @Class XmlItem XmlItem.hpp "XmlItem.hpp"
      * @Description Class representing an XML item.
      * @Author Marco Barbosa
      */
      class XmlItem : public Stringable
      {
        public:
          /**
          * @Description Method to check if XmlItem is of type XmlElement
          * @Returns True if XmlItem is of type XmlElement, false otherwise
          */
          virtual const bool isXmlElement() const;
          
          /**
          * @Description Method to check if XmlItem is of type XmlCharData
          * @Returns True if XmlItem is of type XmlCharData, false otherwise
          */
          virtual const bool isXmlCharData() const;
          
          /**
          * @Description String cast operator
          */
          virtual operator string() const = 0;
      }; // XmlItem
    } // namespace xml
  } // namespace support
} // namespace mermaid

#endif // __XML_XMLITEM_H_