mlclient::utilities::PugiXmlDocumentNode Class Reference

Represents a Node within a pugi::xml::document instance. More...

#include <PugiXmlDocumentContent.hpp>

Inheritance diagram for mlclient::utilities::PugiXmlDocumentNode:

Public Member Functions
MLCLIENT_API	PugiXmlDocumentNode (const pugi::xml_node &result)
MLCLIENT_API	PugiXmlDocumentNode (const pugi::xml_node &root, const std::string &key)
MLCLIENT_API	PugiXmlDocumentNode (PugiXmlDocumentNode &&from)
MLCLIENT_API bool	isNull () const override
	Does this document element have a blank value? More...
MLCLIENT_API bool	isBoolean () const override
	Whether this element or property is a boolean type. More...
MLCLIENT_API bool	isInteger () const override
	Whether this element or property is a integer type. More...
MLCLIENT_API bool	isDouble () const override
	Whether this element or property is a double type. More...
MLCLIENT_API bool	isString () const override
	Whether this element or property is a string type. More...
MLCLIENT_API bool	isArray () const override
	Whether this element or property is an array type. More...
MLCLIENT_API bool	isObject () const override
	Whether this element or property is an object type (i.e. a JSON object or an XML element with element content) More...
MLCLIENT_API bool	asBoolean () const override
	Returns the boolean value of this element or property. More...
MLCLIENT_API int32_t	asInteger () const override
	Returns the integer value of this element or property. More...
MLCLIENT_API double	asDouble () const override
	Returns the double value of this element or property. More...
MLCLIENT_API std::string	asString () const override
	Returns the string value of this element or property. More...
MLCLIENT_API IDocumentNode *	asArray () const override
	Returns the array value of this element or property (i.e. the child objects) More...
MLCLIENT_API IDocumentNode *	asObject () const override
	Returns the Object value of this element or property (i.e. the child object) More...
MLCLIENT_API IDocumentNode *	at (const std::string &key) const override
MLCLIENT_API IDocumentNode *	at (const int32_t idx) const override

Detailed Description

Represents a Node within a 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

Member Function Documentation

MLCLIENT_API IDocumentNode* mlclient::utilities::PugiXmlDocumentNode::asArray ( ) const

overridevirtual

Returns the array value of this element or property (i.e. the child objects)

Exceptions

InvalidFormatException

if not of the right type

Returns

The array value

Implements mlclient::IDocumentNode.

MLCLIENT_API bool mlclient::utilities::PugiXmlDocumentNode::asBoolean ( ) const

overridevirtual

Returns the boolean value of this element or property.

Exceptions

InvalidFormatException

if not of the right type

Returns

The boolean value

Implements mlclient::IDocumentNode.

MLCLIENT_API double mlclient::utilities::PugiXmlDocumentNode::asDouble ( ) const

overridevirtual

Returns the double value of this element or property.

Exceptions

InvalidFormatException

if not of the right type

Returns

The double value

Implements mlclient::IDocumentNode.

MLCLIENT_API int32_t mlclient::utilities::PugiXmlDocumentNode::asInteger ( ) const

overridevirtual

Returns the integer value of this element or property.

Exceptions

InvalidFormatException

if not of the right type

Returns

The integer value

Implements mlclient::IDocumentNode.

MLCLIENT_API IDocumentNode* mlclient::utilities::PugiXmlDocumentNode::asObject ( ) const

overridevirtual

Returns the Object value of this element or property (i.e. the child object)

Exceptions

InvalidFormatException

if not of the right type

Returns

The Node object value

Implements mlclient::IDocumentNode.

MLCLIENT_API std::string mlclient::utilities::PugiXmlDocumentNode::asString ( ) const

overridevirtual

Returns the string value of this element or property.

Exceptions

InvalidFormatException

if not of the right type

Returns

The string value

Implements mlclient::IDocumentNode.

MLCLIENT_API bool mlclient::utilities::PugiXmlDocumentNode::isArray ( ) const

overridevirtual

Whether this element or property is an array type.

Returns

True if of type array

Implements mlclient::IDocumentNode.

MLCLIENT_API bool mlclient::utilities::PugiXmlDocumentNode::isBoolean ( ) const

overridevirtual

Whether this element or property is a boolean type.

Returns

True if of type boolean

Implements mlclient::IDocumentNode.

MLCLIENT_API bool mlclient::utilities::PugiXmlDocumentNode::isDouble ( ) const

overridevirtual

Whether this element or property is a double type.

Returns

True if of type double

Implements mlclient::IDocumentNode.

MLCLIENT_API bool mlclient::utilities::PugiXmlDocumentNode::isInteger ( ) const

overridevirtual

Whether this element or property is a integer type.

Returns

True if of type integer

Implements mlclient::IDocumentNode.

MLCLIENT_API bool mlclient::utilities::PugiXmlDocumentNode::isNull ( ) const

overridevirtual

Does this document element have a blank value?

Returns

True if the value is blank. E.g. {"data":""} or <data>

Implements mlclient::IDocumentNode.

MLCLIENT_API bool mlclient::utilities::PugiXmlDocumentNode::isObject ( ) const

overridevirtual

Whether this element or property is an object type (i.e. a JSON object or an XML element with element content)

Returns

True if of type Object

Implements mlclient::IDocumentNode.

MLCLIENT_API bool mlclient::utilities::PugiXmlDocumentNode::isString ( ) const

overridevirtual

Whether this element or property is a string type.

Returns

True if of type string

Implements mlclient::IDocumentNode.

---

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

• include/mlclient/utilities/PugiXmlDocumentContent.hpp