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

#ifndef __XML_XMLCHARDATA_H_
#define __XML_XMLCHARDATA_H_

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

#include <string>

#include <boost/shared_ptr.hpp>

#include "XmlItem.hpp"

namespace mermaid
{
  namespace support
  {
    namespace xml
    {
      using std::string;
      using boost::shared_ptr;
      
      typedef vector<shared_ptr<XmlCharData> > XmlCharDataVector;
      
      /**
      * @Class XmlCharData XmlCharData.h "XmlCharData.h"
      * @Description Class that holds CharData from XML files.
      * @Description Inherits from string.
      * @Author Marco Barbosa
      */
      class XmlCharData : public XmlItem
      {
        public:
          /**
          * Constructor
          * Creates an empty XmlCharData instance.
          */
          XmlCharData();
          
          /**
          * Constructor
          * Creates an XmlCharData instance from a C-like string.
          * @Argument c C-like string
          */
          XmlCharData (const char*c);
          
          virtual XmlCharData * clone();
          
          /**
          * Constructor
          * Creates an XmlCharData instance from a string.
          * @Argument s string
          */
          XmlCharData (string s);
          
          /**
          * Copy constructor.
          */
          XmlCharData (const XmlCharData &c);
          
          /**
          * Checks if instance is filled only with blank characters.
          * @Returns TRUE if instance is filled only with blanks,
          * FALSE otherwise.
          */
          const bool isBlank() const;
          
          /**
          * Removes blank characters from the beginning and end.
          */
          void removeEndBlanks();
          
          /**
          * @Description Method to convert value to string
          */
          virtual operator string() const;
          
          /**
           * @Description Method to check if XmlItem is of type XmlCharData
           * @Returns True
           */
          virtual const bool isXmlCharData() const;
          
        private:
          string string_;
      }; // class XmlCharData
    } // namespace xml
  } // namespace support
} // namespace mermaid

#endif // __XML_XMLCHARDATA_H_