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 EmptyXMLError : public std::runtime_error
{public: EmptyXMLError(const std::string& what_arg) : std::runtime_error(what_arg) {}};

class TEUCHOS_LIB_DLL_EXPORT XMLObject
{
public:



  XMLObject() : ptr_() {;}

  XMLObject(const std::string& tag);

  XMLObject(XMLObjectImplem* ptr);



  XMLObject deepCopy() const ;



  const std::string& getTag() const;

  bool hasAttribute(const std::string& name) const;

  const std::string& getAttribute(const std::string& name) const;

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

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

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

  bool getRequiredBool(const std::string& name) const ;


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

  int numChildren() const;

  const XMLObject& getChild(int i) const;

  int numContentLines() const;

  const std::string& getContentLine(int i) const;

  std::string toString() const;

  void print(std::ostream& os, int indent) const;

  std::string header() const;

  std::string terminatedHeader() const;

  std::string footer() const;

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

  void checkTag(const std::string& expected) const ;
  


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

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

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

  void addContent(const std::string& contentLine);

private:
//use pragmas to disable some false-positive warnings for windows sharedlibs export
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable:4251)
#endif
  RCP<XMLObjectImplem> ptr_;
#ifdef _MSC_VER
#pragma warning(pop)
#endif
};

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

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

} // namespace Teuchos

#endif