MIDAS  0.75
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Friends Macros
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Friends | List of all members
tinyxml2::XMLNode Class Referenceabstract

XMLNode is a base class for every object that is in the XML Document Object Model (DOM), except XMLAttributes. More...

#include <tinyxml2.h>

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

Public Member Functions

const XMLDocumentGetDocument () const
 Get the XMLDocument that owns this XMLNode. More...
 
XMLDocumentGetDocument ()
 Get the XMLDocument that owns this XMLNode. More...
 
virtual XMLElementToElement ()
 Safely cast to an Element, or null. More...
 
virtual XMLTextToText ()
 Safely cast to Text, or null. More...
 
virtual XMLCommentToComment ()
 Safely cast to a Comment, or null. More...
 
virtual XMLDocumentToDocument ()
 Safely cast to a Document, or null. More...
 
virtual XMLDeclarationToDeclaration ()
 Safely cast to a Declaration, or null. More...
 
virtual XMLUnknownToUnknown ()
 Safely cast to an Unknown, or null. More...
 
virtual const XMLElementToElement () const
 
virtual const XMLTextToText () const
 
virtual const XMLCommentToComment () const
 
virtual const XMLDocumentToDocument () const
 
virtual const XMLDeclarationToDeclaration () const
 
virtual const XMLUnknownToUnknown () const
 
const char * Value () const
 The meaning of 'value' changes for the specific type. More...
 
void SetValue (const char *val, bool staticMem=false)
 Set the Value of an XML node. More...
 
const XMLNodeParent () const
 Get the parent of this node on the DOM. More...
 
XMLNodeParent ()
 
bool NoChildren () const
 Returns true if this node has no children. More...
 
const XMLNodeFirstChild () const
 Get the first child node, or null if none exists. More...
 
XMLNodeFirstChild ()
 
const XMLElementFirstChildElement (const char *value=0) const
 Get the first child element, or optionally the first child element with the specified name. More...
 
XMLElementFirstChildElement (const char *value=0)
 
const XMLNodeLastChild () const
 Get the last child node, or null if none exists. More...
 
XMLNodeLastChild ()
 
const XMLElementLastChildElement (const char *value=0) const
 Get the last child element or optionally the last child element with the specified name. More...
 
XMLElementLastChildElement (const char *value=0)
 
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)
 
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)
 
XMLNodeInsertEndChild (XMLNode *addThis)
 Add a child node as the last (right) child. More...
 
XMLNodeLinkEndChild (XMLNode *addThis)
 
XMLNodeInsertFirstChild (XMLNode *addThis)
 Add a child node as the first (left) child. More...
 
XMLNodeInsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
 Add a node after the specified child node. More...
 
void DeleteChildren ()
 Delete all the children of this node. More...
 
void DeleteChild (XMLNode *node)
 Delete a child of this node. More...
 
virtual XMLNodeShallowClone (XMLDocument *document) const =0
 Make a copy of this node, but not its children. More...
 
virtual bool ShallowEqual (const XMLNode *compare) const =0
 Test if 2 nodes are the same, but don't test children. More...
 
virtual bool Accept (XMLVisitor *visitor) const =0
 Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. More...
 
virtual char * ParseDeep (char *, StrPair *)
 

Protected Member Functions

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

Protected Attributes

XMLDocument_document
 
XMLNode_parent
 
StrPair _value
 
XMLNode_firstChild
 
XMLNode_lastChild
 
XMLNode_prev
 
XMLNode_next
 

Private Member Functions

void Unlink (XMLNode *child)
 

Private Attributes

MemPool_memPool
 

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 579 of file tinyxml2.h.

Constructor & Destructor Documentation

tinyxml2::XMLNode::XMLNode ( XMLDocument doc)
protected

Definition at line 589 of file tinyxml2.cpp.

tinyxml2::XMLNode::~XMLNode ( )
protectedvirtual

Definition at line 599 of file tinyxml2.cpp.

References _parent, DeleteChildren(), and Unlink().

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.

Definition at line 651 of file tinyxml2.cpp.

References _parent, DELETE_NODE, and TIXMLASSERT.

Referenced by tinyxml2::XMLDocument::DeleteNode(), and midaspace::Problem::read_head_and_chars().

void tinyxml2::XMLNode::DeleteChildren ( )

Delete all the children of this node.

Definition at line 619 of file tinyxml2.cpp.

References _firstChild, _lastChild, DELETE_NODE, and Unlink().

Referenced by tinyxml2::XMLDocument::Clear(), tinyxml2::XMLDocument::~XMLDocument(), and ~XMLNode().

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

Definition at line 675 of file tinyxml2.h.

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.

Definition at line 730 of file tinyxml2.cpp.

References _firstChild, _next, tinyxml2::XMLElement::Name(), tinyxml2::XMLUtil::StringEqual(), and tinyxml2::XMLElement::ToElement().

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

Definition at line 684 of file tinyxml2.h.

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

Get the XMLDocument that owns this XMLNode.

Definition at line 586 of file tinyxml2.h.

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

Get the XMLDocument that owns this XMLNode.

Definition at line 590 of file tinyxml2.h.

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

Add a node after the specified child node.

Definition at line 707 of file tinyxml2.cpp.

References _memPool, _next, _parent, _prev, InsertEndChild(), tinyxml2::MemPool::SetTracked(), and TIXMLASSERT.

XMLNode * tinyxml2::XMLNode::InsertEndChild ( XMLNode addThis)
XMLNode * tinyxml2::XMLNode::InsertFirstChild ( XMLNode addThis)

Add a child node as the first (left) child.

Definition at line 682 of file tinyxml2.cpp.

References _firstChild, _lastChild, _memPool, _next, _parent, _prev, tinyxml2::MemPool::SetTracked(), and TIXMLASSERT.

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

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

Definition at line 689 of file tinyxml2.h.

Referenced by midaspace::Mesh::print_VTK_nodes().

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

Definition at line 693 of file tinyxml2.h.

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.

Definition at line 744 of file tinyxml2.cpp.

References _lastChild, _prev, tinyxml2::XMLElement::Name(), tinyxml2::XMLUtil::StringEqual(), and tinyxml2::XMLElement::ToElement().

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

Definition at line 702 of file tinyxml2.h.

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

Definition at line 743 of file tinyxml2.h.

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

Definition at line 727 of file tinyxml2.h.

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

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

Definition at line 758 of file tinyxml2.cpp.

References _next, tinyxml2::XMLUtil::StringEqual(), and tinyxml2::XMLElement::ToElement().

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

Definition at line 734 of file tinyxml2.h.

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

Returns true if this node has no children.

Definition at line 666 of file tinyxml2.h.

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

Get the parent of this node on the DOM.

Definition at line 657 of file tinyxml2.h.

Referenced by midaspace::Problem::read_block().

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

Definition at line 661 of file tinyxml2.h.

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

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

Definition at line 707 of file tinyxml2.h.

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

Definition at line 711 of file tinyxml2.h.

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

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

Definition at line 770 of file tinyxml2.cpp.

References _prev, tinyxml2::XMLUtil::StringEqual(), and tinyxml2::XMLElement::ToElement().

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

Definition at line 718 of file tinyxml2.h.

void tinyxml2::XMLNode::SetValue ( const char *  val,
bool  staticMem = false 
)
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.

Definition at line 603 of file tinyxml2.h.

Referenced by midaspace::Problem::read_head_and_chars(), and tinyxml2::XMLComment::ShallowEqual().

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

Reimplemented in tinyxml2::XMLComment.

Definition at line 625 of file tinyxml2.h.

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

Safely cast to a Declaration, or null.

Reimplemented in tinyxml2::XMLDeclaration.

Definition at line 611 of file tinyxml2.h.

Referenced by midaspace::Problem::read_head_and_chars(), and tinyxml2::XMLDeclaration::ShallowEqual().

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

Reimplemented in tinyxml2::XMLDeclaration.

Definition at line 631 of file tinyxml2.h.

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

Safely cast to a Document, or null.

Reimplemented in tinyxml2::XMLDocument.

Definition at line 607 of file tinyxml2.h.

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

Reimplemented in tinyxml2::XMLDocument.

Definition at line 628 of file tinyxml2.h.

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

Reimplemented in tinyxml2::XMLElement.

Definition at line 619 of file tinyxml2.h.

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

Reimplemented in tinyxml2::XMLText.

Definition at line 622 of file tinyxml2.h.

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

Safely cast to an Unknown, or null.

Reimplemented in tinyxml2::XMLUnknown.

Definition at line 615 of file tinyxml2.h.

Referenced by tinyxml2::XMLUnknown::ShallowEqual().

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

Reimplemented in tinyxml2::XMLUnknown.

Definition at line 634 of file tinyxml2.h.

void tinyxml2::XMLNode::Unlink ( XMLNode child)
private

Definition at line 631 of file tinyxml2.cpp.

References _firstChild, _lastChild, _next, _parent, _prev, and TIXMLASSERT.

Referenced by DeleteChildren(), and ~XMLNode().

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

Friends And Related Function Documentation

friend class XMLDocument
friend

Definition at line 581 of file tinyxml2.h.

friend class XMLElement
friend

Definition at line 582 of file tinyxml2.h.

Member Data Documentation

XMLDocument* tinyxml2::XMLNode::_document
protected
XMLNode* tinyxml2::XMLNode::_firstChild
protected
XMLNode* tinyxml2::XMLNode::_lastChild
protected
MemPool* tinyxml2::XMLNode::_memPool
private
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 files: