mlclient::utilities::PugiXmlDocumentNavigator Class Reference

Provides a navigator interface over a PugiXmlDocumentContent's root pugi::xml_document instance. More...

#include <PugiXmlDocumentContent.hpp>

Inheritance diagram for mlclient::utilities::PugiXmlDocumentNavigator:

Public Member Functions
	PugiXmlDocumentNavigator (const pugi::xml_document &root, bool firstElementAsRoot=false)
	Creates a Pugi XML based Document Navigator for the Document Traversal API. More...
MLCLIENT_API	PugiXmlDocumentNavigator (PugiXmlDocumentNavigator &&from)
	Move constructor for moving ownership of this instance. More...
virtual	~PugiXmlDocumentNavigator ()
	Pugi XML destructor.
MLCLIENT_API IDocumentNode *	at (const std::string &key) const override
	Returns the IDocumentNode at the specified key location. More...

Detailed Description

Provides a navigator interface over a PugiXmlDocumentContent's root pugi::xml_document instance.

Author

Adam Fowler adam..nosp@m.fowl.nosp@m.er@ma.nosp@m.rklo.nosp@m.gic.c.nosp@m.om

Since

8.0.2

Date

2016-07-30

Constructor & Destructor Documentation

mlclient::utilities::PugiXmlDocumentNavigator::PugiXmlDocumentNavigator	(	const pugi::xml_document &	root,
		bool	firstElementAsRoot = false
	)

Creates a Pugi XML based Document Navigator for the Document Traversal API.

Parameters

root	The PUGI XML document to wrap
firstElementAsRoot	Whether to start with the root (document) element (false) or the first actual node element (true)

MLCLIENT_API mlclient::utilities::PugiXmlDocumentNavigator::PugiXmlDocumentNavigator

(

PugiXmlDocumentNavigator &&

from

)

Move constructor for moving ownership of this instance.

Parameters

from	The object instance to move the ownership of resources from

Member Function Documentation

MLCLIENT_API IDocumentNode* mlclient::utilities::PugiXmlDocumentNavigator::at ( const std::string &  key ) const

overridevirtual

Returns the IDocumentNode at the specified key location.

See IDocumentNavigator for details.

Parameters

key	The name of the node to return

Returns

The node at that named location. nullptr if it doesn't exist

Implements mlclient::IDocumentNavigator.

---

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

• include/mlclient/utilities/PugiXmlDocumentContent.hpp