scram::xml::Document

XML DOM tree document.

#include <xml.h>

Public Functions

	Name
const xmlDoc *	get() const
xmlDoc *	get()
	Document(const std::string & file_path, Validator * validator =nullptr)<br>Parses XML input document.
Element	root() const

Public Functions Documentation

function get

inline const xmlDoc * get() const

Return: The underlying data document.

function get

inline xmlDoc * get()

function Document

explicit Document(
    const std::string & file_path,
    Validator * validator =nullptr
)

Parses XML input document.

Parameters:

• file_path The path to the document file.
• validator Optional validator against the RNG schema.

Exceptions:

• IOError The file is not available.
• ParseError There are XML parsing failures.
• XIncludeError XInclude resolution has failed.
• ValidityError The XML file is not valid.

Return: The initialized document.

All XInclude directives are processed into the final document.

function root

inline Element root() const

Return: The root element of the document.

Precondition: The document has a root node.

---

Updated on 2025-11-11 at 16:51:08 +0000