OpenCV  3.0.0-rc1
Open Source Computer Vision
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
tinyxml2::XMLNode Class Referenceabstract

#include "tinyxml2.h"

Inheritance diagram for tinyxml2::XMLNode:
tinyxml2::XMLComment tinyxml2::XMLDeclaration tinyxml2::XMLDocument tinyxml2::XMLElement tinyxml2::XMLText tinyxml2::XMLUnknown

Public Member Functions

virtual bool Accept (XMLVisitor *visitor) const =0
 
void DeleteChild (XMLNode *node)
 
void DeleteChildren ()
 
const XMLNodeFirstChild () const
 Get the first child node, or null if none exists. More...
 
XMLNodeFirstChild ()
 
const XMLElementFirstChildElement (const char *value=0) const
 
XMLElementFirstChildElement (const char *value=0)
 
const XMLDocumentGetDocument () const
 Get the XMLDocument that owns this XMLNode. More...
 
XMLDocumentGetDocument ()
 Get the XMLDocument that owns this XMLNode. More...
 
XMLNodeInsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
 
XMLNodeInsertEndChild (XMLNode *addThis)
 
XMLNodeInsertFirstChild (XMLNode *addThis)
 
const XMLNodeLastChild () const
 Get the last child node, or null if none exists. More...
 
XMLNodeLastChild ()
 
const XMLElementLastChildElement (const char *value=0) const
 
XMLElementLastChildElement (const char *value=0)
 
XMLNodeLinkEndChild (XMLNode *addThis)
 
const XMLNodeNextSibling () const
 Get the next (right) sibling node of this node. More...
 
XMLNodeNextSibling ()
 
const XMLElementNextSiblingElement (const char *value=0) const
 Get the next (right) sibling element of this node, with an optionally supplied name. More...
 
XMLElementNextSiblingElement (const char *value=0)
 
bool NoChildren () const
 Returns true if this node has no children. More...
 
const XMLNodeParent () const
 Get the parent of this node on the DOM. More...
 
XMLNodeParent ()
 
virtual char * ParseDeep (char *, StrPair *)
 
const XMLNodePreviousSibling () const
 Get the previous (left) sibling node of this node. More...
 
XMLNodePreviousSibling ()
 
const XMLElementPreviousSiblingElement (const char *value=0) const
 Get the previous (left) sibling element of this node, with an optionally supplied name. More...
 
XMLElementPreviousSiblingElement (const char *value=0)
 
void SetValue (const char *val, bool staticMem=false)
 
virtual XMLNodeShallowClone (XMLDocument *document) const =0
 
virtual bool ShallowEqual (const XMLNode *compare) const =0
 
virtual XMLCommentToComment ()
 Safely cast to a Comment, or null. More...
 
virtual const XMLCommentToComment () const
 
virtual XMLDeclarationToDeclaration ()
 Safely cast to a Declaration, or null. More...
 
virtual const XMLDeclarationToDeclaration () const
 
virtual XMLDocumentToDocument ()
 Safely cast to a Document, or null. More...
 
virtual const XMLDocumentToDocument () const
 
virtual XMLElementToElement ()
 Safely cast to an Element, or null. More...
 
virtual const XMLElementToElement () const
 
virtual XMLTextToText ()
 Safely cast to Text, or null. More...
 
virtual const XMLTextToText () const
 
virtual XMLUnknownToUnknown ()
 Safely cast to an Unknown, or null. More...
 
virtual const XMLUnknownToUnknown () const
 
const char * Value () const
 

Protected Member Functions

 XMLNode (XMLDocument *)
 
 XMLNode (const XMLNode &)
 
virtual ~XMLNode ()
 
XMLNodeoperator= (const XMLNode &)
 

Protected Attributes

XMLDocument_document
 
XMLNode_firstChild
 
XMLNode_lastChild
 
XMLNode_next
 
XMLNode_parent
 
XMLNode_prev
 
StrPair _value
 

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)

Constructor & Destructor Documentation

tinyxml2::XMLNode::XMLNode ( XMLDocument )
protected
virtual tinyxml2::XMLNode::~XMLNode ( )
protectedvirtual
tinyxml2::XMLNode::XMLNode ( const XMLNode )
protected

Member Function Documentation

virtual bool 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 tinyxml2::XMLDocument, tinyxml2::XMLElement, tinyxml2::XMLUnknown, tinyxml2::XMLDeclaration, tinyxml2::XMLComment, and tinyxml2::XMLText.

void tinyxml2::XMLNode::DeleteChild ( XMLNode node)

Delete a child of this node.

void tinyxml2::XMLNode::DeleteChildren ( )

Delete all the children of this node.

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

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

XMLNode* tinyxml2::XMLNode::FirstChild ( )
inline
const XMLElement* tinyxml2::XMLNode::FirstChildElement ( const char *  value = 0) const

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

XMLElement* tinyxml2::XMLNode::FirstChildElement ( const char *  value = 0)
inline
const XMLDocument* tinyxml2::XMLNode::GetDocument ( ) const
inline

Get the XMLDocument that owns this XMLNode.

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

Get the XMLDocument that owns this XMLNode.

XMLNode* 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.

XMLNode* 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.

XMLNode* 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.

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

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

XMLNode* tinyxml2::XMLNode::LastChild ( )
inline
const XMLElement* tinyxml2::XMLNode::LastChildElement ( const char *  value = 0) const

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

XMLElement* tinyxml2::XMLNode::LastChildElement ( const char *  value = 0)
inline
XMLNode* tinyxml2::XMLNode::LinkEndChild ( XMLNode addThis)
inline
const XMLNode* tinyxml2::XMLNode::NextSibling ( ) const
inline

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

XMLNode* tinyxml2::XMLNode::NextSibling ( )
inline
const XMLElement* tinyxml2::XMLNode::NextSiblingElement ( const char *  value = 0) const

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

XMLElement* tinyxml2::XMLNode::NextSiblingElement ( const char *  value = 0)
inline
bool tinyxml2::XMLNode::NoChildren ( ) const
inline

Returns true if this node has no children.

XMLNode& tinyxml2::XMLNode::operator= ( const XMLNode )
protected
const XMLNode* tinyxml2::XMLNode::Parent ( ) const
inline

Get the parent of this node on the DOM.

XMLNode* tinyxml2::XMLNode::Parent ( )
inline
virtual char* tinyxml2::XMLNode::ParseDeep ( char *  ,
StrPair  
)
virtual
const XMLNode* tinyxml2::XMLNode::PreviousSibling ( ) const
inline

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

XMLNode* tinyxml2::XMLNode::PreviousSibling ( )
inline
const XMLElement* tinyxml2::XMLNode::PreviousSiblingElement ( const char *  value = 0) const

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

XMLElement* tinyxml2::XMLNode::PreviousSiblingElement ( const char *  value = 0)
inline
void tinyxml2::XMLNode::SetValue ( const char *  val,
bool  staticMem = false 
)

Set the Value of an XML node.

See also
Value()
virtual XMLNode* 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 tinyxml2::XMLDocument, tinyxml2::XMLElement, tinyxml2::XMLUnknown, tinyxml2::XMLDeclaration, tinyxml2::XMLComment, and tinyxml2::XMLText.

virtual bool 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 tinyxml2::XMLDocument, tinyxml2::XMLElement, tinyxml2::XMLUnknown, tinyxml2::XMLDeclaration, tinyxml2::XMLComment, and tinyxml2::XMLText.

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

Safely cast to a Comment, or null.

Reimplemented in tinyxml2::XMLComment.

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

Reimplemented in tinyxml2::XMLComment.

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

Safely cast to a Declaration, or null.

Reimplemented in tinyxml2::XMLDeclaration.

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

Reimplemented in tinyxml2::XMLDeclaration.

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

Safely cast to a Document, or null.

Reimplemented in tinyxml2::XMLDocument.

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

Reimplemented in tinyxml2::XMLDocument.

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

Safely cast to an Element, or null.

Reimplemented in tinyxml2::XMLElement.

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

Reimplemented in tinyxml2::XMLElement.

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

Safely cast to Text, or null.

Reimplemented in tinyxml2::XMLText.

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

Reimplemented in tinyxml2::XMLText.

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

Safely cast to an Unknown, or null.

Reimplemented in tinyxml2::XMLUnknown.

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

Reimplemented in tinyxml2::XMLUnknown.

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

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

Document:   empty
Element:    name of the element
Comment:    the comment text
Unknown:    the tag contents
Text:       the text string

Friends And Related Function Documentation

friend class XMLDocument
friend
friend class XMLElement
friend

Member Data Documentation

XMLDocument* tinyxml2::XMLNode::_document
protected
XMLNode* tinyxml2::XMLNode::_firstChild
protected
XMLNode* tinyxml2::XMLNode::_lastChild
protected
XMLNode* tinyxml2::XMLNode::_next
protected
XMLNode* tinyxml2::XMLNode::_parent
protected
XMLNode* tinyxml2::XMLNode::_prev
protected
StrPair tinyxml2::XMLNode::_value
mutableprotected

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