gum::XmlDocument Class Reference

An XML document, opaque over ticpp::Document. More...

#include <XmlDocument.h>

Classes
struct	Impl

Public Member Functions
	XmlDocument ()
	XmlDocument (const std::string &filePath)
	~XmlDocument ()
	XmlDocument (XmlDocument &&) noexcept
XmlDocument &	operator= (XmlDocument &&) noexcept
	XmlDocument (const XmlDocument &)=delete
XmlDocument &	operator= (const XmlDocument &)=delete
void	parse (const std::string &content)
void	loadFile ()
	Loads the file passed to the constructor.
bool	noChildren () const
XmlElement	firstChildElement (const std::string &tag) const

Private Attributes
std::unique_ptr< Impl >	_pimpl_

Detailed Description

An XML document, opaque over ticpp::Document.

Definition at line 125 of file XmlDocument.h.

Constructor & Destructor Documentation

XmlDocument() [1/4]

gum::XmlDocument::XmlDocument

(

)

Definition at line 110 of file XmlDocument.cpp.

: _pimpl_(std::make_unique< Impl >()) {}

References _pimpl_.

Referenced by XmlDocument(), XmlDocument(), operator=(), operator=(), and parse().

Here is the caller graph for this function:

XmlDocument() [2/4]

gum::XmlDocument::XmlDocument ( const std::string & filePath )

explicit

Definition at line 112 of file XmlDocument.cpp.

                                                    :
      _pimpl_(std::make_unique< Impl >(filePath)) {}

References _pimpl_.

~XmlDocument()

gum::XmlDocument::~XmlDocument ( )

default

XmlDocument() [3/4]

gum::XmlDocument::XmlDocument ( XmlDocument && )

defaultnoexcept

References XmlDocument().

Here is the call graph for this function:

XmlDocument() [4/4]

gum::XmlDocument::XmlDocument ( const XmlDocument & )

delete

References XmlDocument().

Here is the call graph for this function:

Member Function Documentation

firstChildElement()

XmlElement gum::XmlDocument::firstChildElement

(

const std::string &

tag

)

const

Exceptions

XmlException

if no such child exists.

Definition at line 133 of file XmlDocument.cpp.

                                                                      {
    try {
      return XmlElement(_pimpl_->doc.FirstChildElement(tag));
    } catch (ticpp::Exception& e) { throw XmlException(e.what()); }
  }

References gum::XmlElement::XmlElement(), gum::XmlException::XmlException(), and _pimpl_.

Referenced by operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

loadFile()

void gum::XmlDocument::loadFile

(

)

Loads the file passed to the constructor.

Exceptions

XmlException

on failure.

Definition at line 125 of file XmlDocument.cpp.

                             {
    try {
      _pimpl_->doc.LoadFile();
    } catch (ticpp::Exception& e) { throw XmlException(e.what()); }
  }

References gum::XmlException::XmlException(), and _pimpl_.

Referenced by operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

noChildren()

bool gum::XmlDocument::noChildren

(

)

const

Definition at line 131 of file XmlDocument.cpp.

{ return _pimpl_->doc.NoChildren(); }

References _pimpl_.

Referenced by operator=().

Here is the caller graph for this function:

operator=() [1/2]

XmlDocument & gum::XmlDocument::operator= ( const XmlDocument & )

delete

References XmlDocument(), firstChildElement(), loadFile(), noChildren(), and parse().

Here is the call graph for this function:

operator=() [2/2]

XmlDocument & gum::XmlDocument::operator= ( XmlDocument && )

defaultnoexcept

References XmlDocument().

Here is the call graph for this function:

parse()

void gum::XmlDocument::parse

(

const std::string &

content

)

Exceptions

XmlException

on a parse error.

Definition at line 119 of file XmlDocument.cpp.

                                                  {
    try {
      _pimpl_->doc.Parse(content);
    } catch (ticpp::Exception& e) { throw XmlException(e.what()); }
  }

References XmlDocument(), gum::XmlException::XmlException(), _pimpl_, and parse().

Referenced by operator=(), and parse().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_pimpl_

std::unique_ptr< Impl > gum::XmlDocument::_pimpl_

private

Definition at line 149 of file XmlDocument.h.

Referenced by XmlDocument(), XmlDocument(), firstChildElement(), loadFile(), noChildren(), and parse().

---

The documentation for this class was generated from the following files:

• agrum/BN/io/xml/XmlDocument.h
• agrum/BN/io/xml/XmlDocument.cpp