Teuchos_XMLObject.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library 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 2.1 of the
// License, or (at your option) any later version.
//  
// This library 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 this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef Teuchos_XMLOBJECT_H
#define Teuchos_XMLOBJECT_H

#include "Teuchos_XMLObjectImplem.hpp"
#include "Teuchos_Utils.hpp"

namespace Teuchos
{

  class XMLObject
    {
    public:

      XMLObject() : ptr_() {;}

      XMLObject(const string& tag);

      XMLObject(XMLObjectImplem* ptr);


      XMLObject deepCopy() const ;


      const string& getTag() const {return ptr_->getTag();}

      bool hasAttribute(const string& name) const 
        {return ptr_->hasAttribute(name);}

      const string& getAttribute(const string& name) const 
        {return ptr_->getAttribute(name);}

      const string& getRequired(const string& name) const ;

      double getRequiredDouble(const string& name) const 
        {return atof(getRequired(name).c_str());}

      int getRequiredInt(const string& name) const 
        {return atoi(getRequired(name).c_str());}

      bool getRequiredBool(const string& name) const ;


      string getWithDefault(const string& name, 
            const string& defaultValue) const ;

      int numChildren() const {return ptr_->numChildren();}

      const XMLObject& getChild(int i) const {return ptr_->getChild(i);}

      int numContentLines() const {return ptr_->numContentLines();}

      const string& getContentLine(int i) const {return ptr_->getContentLine(i);}

      string toString() const {return ptr_->toString();}

      void print(ostream& os, int indent) const
      {ptr_->print(os, indent);}


      string header() const {return ptr_->header();}

      string terminatedHeader() const {return ptr_->terminatedHeader();}

      string footer() const {return ptr_->footer();}

      bool isEmpty() const {return ptr_.get()==0;}

      void checkTag(const string& expected) const ;
  

      void addAttribute(const string& name, const string& value)
        {ptr_->addAttribute(name, value);}
      
      void addDouble(const string& name, double val)
        {addAttribute(name, Teuchos::toString(val));}

      void addInt(const string& name, int val)
        {addAttribute(name, Teuchos::toString(val));}

      void addBool(const string& name, bool val)
        {addAttribute(name, Teuchos::toString(val));}
      
      void addChild(const XMLObject& child)
        {ptr_->addChild(child);}

      void addContent(const string& contentLine)
        {ptr_->addContent(contentLine);}
  
    private:
      RefCountPtr<XMLObjectImplem> ptr_;
    };

  inline ostream& operator<<(ostream& os, const XMLObject& xml)
    {
      xml.print(os, 0);
      return os;
    }

  inline string toString(const XMLObject& xml)
    {
      return xml.toString();
    }

}
#endif

---