musx::xml::IXmlDocument Class Reference

Interface for an XML document. More...

#include <XmlInterface.h>

Inheritance diagram for musx::xml::IXmlDocument:

Public Member Functions
virtual void	loadFromBuffer (const char *data, size_t size)=0
	Loads XML content from buffer.
virtual void	loadFromString (const std::string &xmlContent)=0
	Loads XML content from a string.
void	loadFromString (const std::vector< char > &xmlContent)
	Loads XML content from a vector of characters.
virtual std::shared_ptr< IXmlElement >	getRootElement () const =0
	Gets the root element of the document.

Detailed Description

Interface for an XML document.

Member Function Documentation

getRootElement()

virtual std::shared_ptr< IXmlElement > musx::xml::IXmlDocument::getRootElement ( ) const

pure virtual

Gets the root element of the document.

Returns

A shared pointer to the root element, or nullptr if the document is empty.

Implemented in musx::xml::pugi::Document, musx::xml::rapidxml::Document, and musx::xml::tinyxml2::Document.

loadFromBuffer()

virtual void musx::xml::IXmlDocument::loadFromBuffer ( const char *  data, size_t  size  )

pure virtual

Loads XML content from buffer.

Parameters

data	pointer to the XML content.
size	size of the XML content.

Exceptions

musx::xml::load_error

if the load fails.

Implemented in musx::xml::pugi::Document, musx::xml::rapidxml::Document, and musx::xml::tinyxml2::Document.

loadFromString() [1/2]

virtual void musx::xml::IXmlDocument::loadFromString ( const std::string &  xmlContent )

pure virtual

Loads XML content from a string.

Parameters

xmlContent

The XML content as a string.

Exceptions

musx::xml::load_error

if the load fails.

Implemented in musx::xml::pugi::Document, musx::xml::rapidxml::Document, and musx::xml::tinyxml2::Document.

loadFromString() [2/2]

void musx::xml::IXmlDocument::loadFromString ( const std::vector< char > &  xmlContent )

inline

Loads XML content from a vector of characters.

Parameters

xmlContent

The XML content as a vector of characters.

Exceptions

musx::xml::load_error

if the load fails.