gum::XmlElement Class Reference

A non-owning handle to an XML element, opaque over ticpp::Element. More...

#include <XmlDocument.h>

Public Member Functions
	XmlElement ()=default
bool	isNull () const noexcept
XmlElement	firstChildElement (const std::string &tag) const
XmlElement	firstChildElement (const std::string &tag, bool throwIfNotFound) const
	Returns a null XmlElement instead of throwing when throwIfNotFound is false.
std::vector< XmlElement >	children (const std::string &tag) const
	All direct children with this tag, in document order.
std::string	textOrDefault (const std::string &defaultValue) const
std::string	attribute (const std::string &name) const
bool	attribute (const std::string &name, std::string *out, bool throwIfNotFound=false) const
	Returns false instead of throwing when the attribute is missing and throwIfNotFound is false; *out is left untouched in that case.

Private Member Functions
	XmlElement (void *ticppElement) noexcept

Private Attributes
void *	_handle_ = nullptr
	opaque ticpp::Element*, never exposed

Friends
class	XmlDocument

Detailed Description

A non-owning handle to an XML element, opaque over ticpp::Element.

Default-constructed (or returned by a failed non-throwing lookup) as null: check with isNull() before use.

Definition at line 89 of file XmlDocument.h.

Constructor & Destructor Documentation

XmlElement() [1/2]

gum::XmlElement::XmlElement ( )

default

Referenced by children(), gum::XmlDocument::firstChildElement(), firstChildElement(), and firstChildElement().

Here is the caller graph for this function:

XmlElement() [2/2]

gum::XmlElement::XmlElement ( void * ticppElement )

inlineexplicitprivatenoexcept

Definition at line 116 of file XmlDocument.h.

: _handle_(ticppElement) {}

References _handle_.

Member Function Documentation

attribute() [1/2]

std::string gum::XmlElement::attribute

(

const std::string &

name

)

const

Exceptions

XmlException

if the attribute is missing.

Definition at line 82 of file XmlDocument.cpp.

                                                             {
    auto* self = static_cast< ticpp::Element* >(_handle_);
    try {
      return self->GetAttribute(name);
    } catch (ticpp::Exception& e) { throw XmlException(e.what()); }
  }

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

Here is the call graph for this function:

attribute() [2/2]

bool gum::XmlElement::attribute	(	const std::string &	name,
		std::string *	out,
		bool	throwIfNotFound = false ) const

Returns false instead of throwing when the attribute is missing and throwIfNotFound is false; *out is left untouched in that case.

Definition at line 90 of file XmlDocument.cpp.

                                                                                             {
    auto* self = static_cast< ticpp::Element* >(_handle_);
    // ticpp's GetAttribute(name, out, false) returns silently (no exception,
    // *out untouched) when the attribute is missing, so the try/catch below
    // never fires on that path -- HasAttribute is the only reliable signal.
    const bool found = self->HasAttribute(name);
    try {
      self->GetAttribute(name, out, throwIfNotFound);
    } catch (ticpp::Exception& e) { throw XmlException(e.what()); }
    return found;
  }

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

Here is the call graph for this function:

children()

std::vector< XmlElement > gum::XmlElement::children

(

const std::string &

tag

)

const

All direct children with this tag, in document order.

Definition at line 66 of file XmlDocument.cpp.

                                                                         {
    std::vector< XmlElement > result;
    if (_handle_ == nullptr) { return result; }
    auto*                             parent = static_cast< ticpp::Element* >(_handle_);
    ticpp::Iterator< ticpp::Element > it(tag);
    for (it = it.begin(parent); it != it.end(); ++it) {
      result.push_back(XmlElement(it.Get()));
    }
    return result;
  }

References XmlElement(), and _handle_.

Here is the call graph for this function:

firstChildElement() [1/2]

XmlElement gum::XmlElement::firstChildElement

(

const std::string &

tag

)

const

Exceptions

XmlException

if no such child exists.

Definition at line 52 of file XmlDocument.cpp.

                                                                     {
    auto* self = static_cast< ticpp::Element* >(_handle_);
    try {
      return XmlElement(self->FirstChildElement(tag));
    } catch (ticpp::Exception& e) { throw XmlException(e.what()); }
  }

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

Here is the call graph for this function:

firstChildElement() [2/2]

XmlElement gum::XmlElement::firstChildElement	(	const std::string &	tag,
		bool	throwIfNotFound ) const

Returns a null XmlElement instead of throwing when throwIfNotFound is false.

Definition at line 59 of file XmlDocument.cpp.

                                                                                           {
    auto* self = static_cast< ticpp::Element* >(_handle_);
    try {
      return XmlElement(self->FirstChildElement(tag, throwIfNotFound));
    } catch (ticpp::Exception& e) { throw XmlException(e.what()); }
  }

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

Here is the call graph for this function:

isNull()

bool gum::XmlElement::isNull ( ) const

inlinenoexcept

Definition at line 93 of file XmlDocument.h.

{ return _handle_ == nullptr; }

References _handle_.

textOrDefault()

std::string gum::XmlElement::textOrDefault

(

const std::string &

defaultValue

)

const

Definition at line 77 of file XmlDocument.cpp.

                                                                         {
    auto* self = static_cast< ticpp::Element* >(_handle_);
    return self->GetTextOrDefault(defaultValue);
  }

References _handle_, and gum::MultiDimFunctionGraph< float >::defaultValue.

Friends And Related Symbol Documentation

XmlDocument

friend class XmlDocument

friend

Definition at line 114 of file XmlDocument.h.

References XmlDocument.

Referenced by XmlDocument.

Member Data Documentation

_handle_

void* gum::XmlElement::_handle_ = nullptr

private

opaque ticpp::Element*, never exposed

Definition at line 118 of file XmlDocument.h.

Referenced by XmlElement(), attribute(), attribute(), children(), firstChildElement(), firstChildElement(), isNull(), and textOrDefault().

---

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

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