AWS SDK for C++

AWS SDK for C++ Version 1.11.804
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
Aws::External::tinyxml2::XMLNode Class Referenceabstract

#include <tinyxml2.h>

Inheritance diagram for Aws::External::tinyxml2::XMLNode:
[legend]

Public Member Functions

const XMLDocument * GetDocument () const
 Get the XMLDocument that owns this XMLNode.
 
XMLDocument * GetDocument ()
 Get the XMLDocument that owns this XMLNode.
 
virtual XMLElement * ToElement ()
 Safely cast to an Element, or null.
 
virtual XMLText * ToText ()
 Safely cast to Text, or null.
 
virtual XMLComment * ToComment ()
 Safely cast to a Comment, or null.
 
virtual XMLDocument * ToDocument ()
 Safely cast to a Document, or null.
 
virtual XMLDeclaration * ToDeclaration ()
 Safely cast to a Declaration, or null.
 
virtual XMLUnknown * ToUnknown ()
 Safely cast to an Unknown, or null.
 
virtual const XMLElement * ToElement () const
 
virtual const XMLText * ToText () const
 
virtual const XMLComment * ToComment () const
 
virtual const XMLDocument * ToDocument () const
 
virtual const XMLDeclaration * ToDeclaration () const
 
virtual const XMLUnknown * ToUnknown () const
 
int ChildElementCount (const char *value) const
 
int ChildElementCount () const
 
const char * Value () const
 
void SetValue (const char *val, bool staticMem=false)
 
int GetLineNum () const
 Gets the line number the node is in, if the document was parsed from a file.
 
const XMLNode * Parent () const
 Get the parent of this node on the DOM.
 
XMLNode * Parent ()
 
bool NoChildren () const
 Returns true if this node has no children.
 
const XMLNode * FirstChild () const
 Get the first child node, or null if none exists.
 
XMLNode * FirstChild ()
 
const XMLElement * FirstChildElement (const char *name=0) const
 
XMLElement * FirstChildElement (const char *name=0)
 
const XMLNode * LastChild () const
 Get the last child node, or null if none exists.
 
XMLNode * LastChild ()
 
const XMLElement * LastChildElement (const char *name=0) const
 
XMLElement * LastChildElement (const char *name=0)
 
const XMLNode * PreviousSibling () const
 Get the previous (left) sibling node of this node.
 
XMLNode * PreviousSibling ()
 
const XMLElement * PreviousSiblingElement (const char *name=0) const
 Get the previous (left) sibling element of this node, with an optionally supplied name.
 
XMLElement * PreviousSiblingElement (const char *name=0)
 
const XMLNode * NextSibling () const
 Get the next (right) sibling node of this node.
 
XMLNode * NextSibling ()
 
const XMLElement * NextSiblingElement (const char *name=0) const
 Get the next (right) sibling element of this node, with an optionally supplied name.
 
XMLElement * NextSiblingElement (const char *name=0)
 
XMLNode * InsertEndChild (XMLNode *addThis)
 
XMLNode * LinkEndChild (XMLNode *addThis)
 
XMLNode * InsertFirstChild (XMLNode *addThis)
 
XMLNode * InsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
 
void DeleteChildren ()
 
void DeleteChild (XMLNode *node)
 
virtual XMLNode * ShallowClone (XMLDocument *document) const =0
 
XMLNode * DeepClone (XMLDocument *target) const
 
virtual bool ShallowEqual (const XMLNode *compare) const =0
 
virtual bool Accept (XMLVisitor *visitor) const =0
 
void SetUserData (void *userData)
 
void * GetUserData () const
 

Protected Member Functions

 XMLNode (XMLDocument *)
 
virtual ~XMLNode ()
 
virtual char * ParseDeep (char *p, StrPair *parentEndTag, int *curLineNumPtr)
 

Protected Attributes

XMLDocument * _document
 
XMLNode * _parent
 
StrPair _value
 
int _parseLineNum
 
XMLNode * _firstChild
 
XMLNode * _lastChild
 
XMLNode * _prev
 
XMLNode * _next
 
void * _userData
 

Friends

class XMLDocument
 
class XMLElement
 

Detailed Description

XMLNode is a base class for every object that is in the XML Document Object Model (DOM), except XMLAttributes. Nodes have siblings, a parent, and children which can be navigated. A node is always in a XMLDocument. The type of a XMLNode can be queried, and it can be cast to its more defined type.

A XMLDocument allocates memory for all its Nodes. When the XMLDocument gets deleted, all its Nodes will also be deleted.

A Document can contain: Element (container or leaf)
                        Comment (leaf)
                        Unknown (leaf)
                        Declaration( leaf )

An Element can contain: Element (container or leaf)
                        Text    (leaf)
                        Attributes (not on tree)
                        Comment (leaf)
                        Unknown (leaf)

Definition at line 684 of file tinyxml2.h.

Constructor & Destructor Documentation

◆ XMLNode()

Aws::External::tinyxml2::XMLNode::XMLNode ( XMLDocument *  )
explicitprotected

◆ ~XMLNode()

virtual Aws::External::tinyxml2::XMLNode::~XMLNode ( )
protectedvirtual

Member Function Documentation

◆ Accept()

virtual bool Aws::External::tinyxml2::XMLNode::Accept ( XMLVisitor *  visitor) const
pure virtual

Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the XMLVisitor interface.

This is essentially a SAX interface for TinyXML-2. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML-2 is unchanged by using this interface versus any other.)

The interface has been based on ideas from:

Which are both good references for "visiting".

An example of using Accept(): 

XMLPrinter printer;
tinyxmlDoc.Accept( &printer );
const char* xmlcstr = printer.CStr();

Implemented in Aws::External::tinyxml2::XMLText, Aws::External::tinyxml2::XMLComment, Aws::External::tinyxml2::XMLDeclaration, Aws::External::tinyxml2::XMLUnknown, Aws::External::tinyxml2::XMLElement, and Aws::External::tinyxml2::XMLDocument.

◆ ChildElementCount() [1/2]

int Aws::External::tinyxml2::XMLNode::ChildElementCount ( ) const

◆ ChildElementCount() [2/2]

int Aws::External::tinyxml2::XMLNode::ChildElementCount ( const char *  value) const

◆ DeepClone()

XMLNode * Aws::External::tinyxml2::XMLNode::DeepClone ( XMLDocument *  target) const

Make a copy of this node and all its children.

If the 'target' is null, then the nodes will be allocated in the current document. If 'target' is specified, the memory will be allocated is the specified XMLDocument.

NOTE: This is probably not the correct tool to copy a document, since XMLDocuments can have multiple top level XMLNodes. You probably want to use XMLDocument::DeepCopy()

◆ DeleteChild()

void Aws::External::tinyxml2::XMLNode::DeleteChild ( XMLNode *  node)

Delete a child of this node.

◆ DeleteChildren()

void Aws::External::tinyxml2::XMLNode::DeleteChildren ( )

Delete all the children of this node.

◆ FirstChild() [1/2]

XMLNode * Aws::External::tinyxml2::XMLNode::FirstChild ( )
inline

Definition at line 789 of file tinyxml2.h.

◆ FirstChild() [2/2]

const XMLNode * Aws::External::tinyxml2::XMLNode::FirstChild ( ) const
inline

Get the first child node, or null if none exists.

Definition at line 785 of file tinyxml2.h.

◆ FirstChildElement() [1/2]

XMLElement * Aws::External::tinyxml2::XMLNode::FirstChildElement ( const char *  name = 0)
inline

Definition at line 798 of file tinyxml2.h.

◆ FirstChildElement() [2/2]

const XMLElement * Aws::External::tinyxml2::XMLNode::FirstChildElement ( const char *  name = 0) const

Get the first child element, or optionally the first child element with the specified name.

◆ GetDocument() [1/2]

XMLDocument * Aws::External::tinyxml2::XMLNode::GetDocument ( )
inline

Get the XMLDocument that owns this XMLNode.

Definition at line 696 of file tinyxml2.h.

◆ GetDocument() [2/2]

const XMLDocument * Aws::External::tinyxml2::XMLNode::GetDocument ( ) const
inline

Get the XMLDocument that owns this XMLNode.

Definition at line 691 of file tinyxml2.h.

◆ GetLineNum()

int Aws::External::tinyxml2::XMLNode::GetLineNum ( ) const
inline

Gets the line number the node is in, if the document was parsed from a file.

Definition at line 768 of file tinyxml2.h.

◆ GetUserData()

void * Aws::External::tinyxml2::XMLNode::GetUserData ( ) const
inline

Get user data set into the XMLNode. TinyXML-2 in no way processes or interprets user data. It is initially 0.

Definition at line 962 of file tinyxml2.h.

◆ InsertAfterChild()

XMLNode * Aws::External::tinyxml2::XMLNode::InsertAfterChild ( XMLNode *  afterThis,
XMLNode *  addThis 
)

Add a node after the specified child node. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the afterThis node is not a child of this node, or if the node does not belong to the same document.

◆ InsertEndChild()

XMLNode * Aws::External::tinyxml2::XMLNode::InsertEndChild ( XMLNode *  addThis)

Add a child node as the last (right) child. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the node does not belong to the same document.

◆ InsertFirstChild()

XMLNode * Aws::External::tinyxml2::XMLNode::InsertFirstChild ( XMLNode *  addThis)

Add a child node as the first (left) child. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the node does not belong to the same document.

◆ LastChild() [1/2]

XMLNode * Aws::External::tinyxml2::XMLNode::LastChild ( )
inline

Definition at line 807 of file tinyxml2.h.

◆ LastChild() [2/2]

const XMLNode * Aws::External::tinyxml2::XMLNode::LastChild ( ) const
inline

Get the last child node, or null if none exists.

Definition at line 803 of file tinyxml2.h.

◆ LastChildElement() [1/2]

XMLElement * Aws::External::tinyxml2::XMLNode::LastChildElement ( const char *  name = 0)
inline

Definition at line 816 of file tinyxml2.h.

◆ LastChildElement() [2/2]

const XMLElement * Aws::External::tinyxml2::XMLNode::LastChildElement ( const char *  name = 0) const

Get the last child element or optionally the last child element with the specified name.

◆ LinkEndChild()

XMLNode * Aws::External::tinyxml2::XMLNode::LinkEndChild ( XMLNode *  addThis)
inline

Definition at line 861 of file tinyxml2.h.

◆ NextSibling() [1/2]

XMLNode * Aws::External::tinyxml2::XMLNode::NextSibling ( )
inline

Definition at line 841 of file tinyxml2.h.

◆ NextSibling() [2/2]

const XMLNode * Aws::External::tinyxml2::XMLNode::NextSibling ( ) const
inline

Get the next (right) sibling node of this node.

Definition at line 837 of file tinyxml2.h.

◆ NextSiblingElement() [1/2]

XMLElement * Aws::External::tinyxml2::XMLNode::NextSiblingElement ( const char *  name = 0)
inline

Definition at line 848 of file tinyxml2.h.

◆ NextSiblingElement() [2/2]

const XMLElement * Aws::External::tinyxml2::XMLNode::NextSiblingElement ( const char *  name = 0) const

Get the next (right) sibling element of this node, with an optionally supplied name.

◆ NoChildren()

bool Aws::External::tinyxml2::XMLNode::NoChildren ( ) const
inline

Returns true if this node has no children.

Definition at line 780 of file tinyxml2.h.

◆ Parent() [1/2]

XMLNode * Aws::External::tinyxml2::XMLNode::Parent ( )
inline

Definition at line 775 of file tinyxml2.h.

◆ Parent() [2/2]

const XMLNode * Aws::External::tinyxml2::XMLNode::Parent ( ) const
inline

Get the parent of this node on the DOM.

Definition at line 771 of file tinyxml2.h.

◆ ParseDeep()

virtual char * Aws::External::tinyxml2::XMLNode::ParseDeep ( char *  p,
StrPair *  parentEndTag,
int *  curLineNumPtr 
)
protectedvirtual

Reimplemented in Aws::External::tinyxml2::XMLText, Aws::External::tinyxml2::XMLComment, Aws::External::tinyxml2::XMLDeclaration, Aws::External::tinyxml2::XMLUnknown, and Aws::External::tinyxml2::XMLElement.

◆ PreviousSibling() [1/2]

XMLNode * Aws::External::tinyxml2::XMLNode::PreviousSibling ( )
inline

Definition at line 825 of file tinyxml2.h.

◆ PreviousSibling() [2/2]

const XMLNode * Aws::External::tinyxml2::XMLNode::PreviousSibling ( ) const
inline

Get the previous (left) sibling node of this node.

Definition at line 821 of file tinyxml2.h.

◆ PreviousSiblingElement() [1/2]

XMLElement * Aws::External::tinyxml2::XMLNode::PreviousSiblingElement ( const char *  name = 0)
inline

Definition at line 832 of file tinyxml2.h.

◆ PreviousSiblingElement() [2/2]

const XMLElement * Aws::External::tinyxml2::XMLNode::PreviousSiblingElement ( const char *  name = 0) const

Get the previous (left) sibling element of this node, with an optionally supplied name.

◆ SetUserData()

void Aws::External::tinyxml2::XMLNode::SetUserData ( void *  userData)
inline

Set user data into the XMLNode. TinyXML-2 in no way processes or interprets user data. It is initially 0.

Definition at line 955 of file tinyxml2.h.

◆ SetValue()

void Aws::External::tinyxml2::XMLNode::SetValue ( const char *  val,
bool  staticMem = false 
)

Set the Value of an XML node.

See also
Value()

◆ ShallowClone()

virtual XMLNode * Aws::External::tinyxml2::XMLNode::ShallowClone ( XMLDocument *  document) const
pure virtual

Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())

Note: if called on a XMLDocument, this will return null.

Implemented in Aws::External::tinyxml2::XMLDocument, Aws::External::tinyxml2::XMLText, Aws::External::tinyxml2::XMLComment, Aws::External::tinyxml2::XMLDeclaration, Aws::External::tinyxml2::XMLUnknown, and Aws::External::tinyxml2::XMLElement.

◆ ShallowEqual()

virtual bool Aws::External::tinyxml2::XMLNode::ShallowEqual ( const XMLNode *  compare) const
pure virtual

Test if 2 nodes are the same, but don't test children. The 2 nodes do not need to be in the same Document.

Note: if called on a XMLDocument, this will return false.

Implemented in Aws::External::tinyxml2::XMLDocument, Aws::External::tinyxml2::XMLText, Aws::External::tinyxml2::XMLComment, Aws::External::tinyxml2::XMLDeclaration, Aws::External::tinyxml2::XMLUnknown, and Aws::External::tinyxml2::XMLElement.

◆ ToComment() [1/2]

virtual XMLComment * Aws::External::tinyxml2::XMLNode::ToComment ( )
inlinevirtual

Safely cast to a Comment, or null.

Reimplemented in Aws::External::tinyxml2::XMLComment.

Definition at line 710 of file tinyxml2.h.

◆ ToComment() [2/2]

virtual const XMLComment * Aws::External::tinyxml2::XMLNode::ToComment ( ) const
inlinevirtual

Reimplemented in Aws::External::tinyxml2::XMLComment.

Definition at line 732 of file tinyxml2.h.

◆ ToDeclaration() [1/2]

virtual XMLDeclaration * Aws::External::tinyxml2::XMLNode::ToDeclaration ( )
inlinevirtual

Safely cast to a Declaration, or null.

Reimplemented in Aws::External::tinyxml2::XMLDeclaration.

Definition at line 718 of file tinyxml2.h.

◆ ToDeclaration() [2/2]

virtual const XMLDeclaration * Aws::External::tinyxml2::XMLNode::ToDeclaration ( ) const
inlinevirtual

Reimplemented in Aws::External::tinyxml2::XMLDeclaration.

Definition at line 738 of file tinyxml2.h.

◆ ToDocument() [1/2]

virtual XMLDocument * Aws::External::tinyxml2::XMLNode::ToDocument ( )
inlinevirtual

Safely cast to a Document, or null.

Reimplemented in Aws::External::tinyxml2::XMLDocument.

Definition at line 714 of file tinyxml2.h.

◆ ToDocument() [2/2]

virtual const XMLDocument * Aws::External::tinyxml2::XMLNode::ToDocument ( ) const
inlinevirtual

Reimplemented in Aws::External::tinyxml2::XMLDocument.

Definition at line 735 of file tinyxml2.h.

◆ ToElement() [1/2]

virtual XMLElement * Aws::External::tinyxml2::XMLNode::ToElement ( )
inlinevirtual

Safely cast to an Element, or null.

Reimplemented in Aws::External::tinyxml2::XMLElement.

Definition at line 702 of file tinyxml2.h.

◆ ToElement() [2/2]

virtual const XMLElement * Aws::External::tinyxml2::XMLNode::ToElement ( ) const
inlinevirtual

Reimplemented in Aws::External::tinyxml2::XMLElement.

Definition at line 726 of file tinyxml2.h.

◆ ToText() [1/2]

virtual XMLText * Aws::External::tinyxml2::XMLNode::ToText ( )
inlinevirtual

Safely cast to Text, or null.

Reimplemented in Aws::External::tinyxml2::XMLText.

Definition at line 706 of file tinyxml2.h.

◆ ToText() [2/2]

virtual const XMLText * Aws::External::tinyxml2::XMLNode::ToText ( ) const
inlinevirtual

Reimplemented in Aws::External::tinyxml2::XMLText.

Definition at line 729 of file tinyxml2.h.

◆ ToUnknown() [1/2]

virtual XMLUnknown * Aws::External::tinyxml2::XMLNode::ToUnknown ( )
inlinevirtual

Safely cast to an Unknown, or null.

Reimplemented in Aws::External::tinyxml2::XMLUnknown.

Definition at line 722 of file tinyxml2.h.

◆ ToUnknown() [2/2]

virtual const XMLUnknown * Aws::External::tinyxml2::XMLNode::ToUnknown ( ) const
inlinevirtual

Reimplemented in Aws::External::tinyxml2::XMLUnknown.

Definition at line 741 of file tinyxml2.h.

◆ Value()

const char * Aws::External::tinyxml2::XMLNode::Value ( ) const

The meaning of 'value' changes for the specific type. 

Document:   empty (NULL is returned, not an empty string)
Element:    name of the element
Comment:    the comment text
Unknown:    the tag contents
Text:       the text string

Friends And Related Symbol Documentation

◆ XMLDocument

friend class XMLDocument
friend

Definition at line 686 of file tinyxml2.h.

◆ XMLElement

friend class XMLElement
friend

Definition at line 687 of file tinyxml2.h.

Member Data Documentation

◆ _document

XMLDocument* Aws::External::tinyxml2::XMLNode::_document
protected

Definition at line 970 of file tinyxml2.h.

◆ _firstChild

XMLNode* Aws::External::tinyxml2::XMLNode::_firstChild
protected

Definition at line 975 of file tinyxml2.h.

◆ _lastChild

XMLNode* Aws::External::tinyxml2::XMLNode::_lastChild
protected

Definition at line 976 of file tinyxml2.h.

◆ _next

XMLNode* Aws::External::tinyxml2::XMLNode::_next
protected

Definition at line 979 of file tinyxml2.h.

◆ _parent

XMLNode* Aws::External::tinyxml2::XMLNode::_parent
protected

Definition at line 971 of file tinyxml2.h.

◆ _parseLineNum

int Aws::External::tinyxml2::XMLNode::_parseLineNum
protected

Definition at line 973 of file tinyxml2.h.

◆ _prev

XMLNode* Aws::External::tinyxml2::XMLNode::_prev
protected

Definition at line 978 of file tinyxml2.h.

◆ _userData

void* Aws::External::tinyxml2::XMLNode::_userData
protected

Definition at line 981 of file tinyxml2.h.

◆ _value

StrPair Aws::External::tinyxml2::XMLNode::_value
mutableprotected

Definition at line 972 of file tinyxml2.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.8
Privacy | Site terms | Cookie preferences