Teuchos_XMLObject.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                    Teuchos: Common Tools Package
//
// Copyright 2004 NTESS and the Teuchos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @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 TEUCHOSPARAMETERLIST_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());}

  template<class T>
  T getRequired(const std::string& name) const{
    T toReturn;
    std::istringstream iss(getRequired(name));
    iss >> toReturn;
    return toReturn;
  }

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

  template<class T>
  T getWithDefault(const std::string& name, const T& defaultValue) const{
    if (hasAttribute(name)){
      return getRequired<T>(name);
    }
    else{
      return defaultValue;
    }
  }

  int numChildren() const;

  const XMLObject& getChild(int i) const;

  int findFirstChild(std::string tagName) 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 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));}

  template<class T>
  void addAttribute(const std::string& name, T value) {
  TEUCHOS_TEST_FOR_EXCEPTION(is_null(ptr_), Teuchos::EmptyXMLError,
         "XMLObject::addAttribute: XMLObject is empty");
  ptr_->addAttribute(name, Teuchos::toString(value));
  }
 
      
  void addChild(const XMLObject& child);

  void addContent(const std::string& contentLine);
 
  void appendContentLine(const size_t& i, const std::string &str) {
    ptr_->appendContentLine(i, str);
  }
 
  void removeContentLine(const size_t& i) {
    ptr_->removeContentLine(i);
  }
 
protected:
 
//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
 
};
 
 
template<>
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT bool XMLObject::getRequired<bool>(const std::string& name) const;
 
template<>
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT int XMLObject::getRequired<int>(const std::string& name) const;
 
template<>
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT double XMLObject::getRequired<double>(const std::string& name) const;
 
template<>
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT std::string XMLObject::getRequired<std::string>(const std::string& name) const;
 
template<>
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void XMLObject::addAttribute<const std::string&>(const std::string& name, const std::string& value);
 

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