Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
tinyxml2::XMLText Class Reference

#include <JETSCAPE/blob/main/external_packages/tinyxml2.h>

+ Inheritance diagram for tinyxml2::XMLText:
+ Collaboration diagram for tinyxml2::XMLText:

Public Member Functions

virtual bool Accept (XMLVisitor *visitor) const
 
virtual XMLTextToText ()
 Safely cast to Text, or null.
 
virtual const XMLTextToText () const
 
void SetCData (bool isCData)
 Declare whether this should be CDATA or standard text.
 
bool CData () const
 Returns true if this is a CDATA text element.
 
virtual XMLNodeShallowClone (XMLDocument *document) const
 
virtual bool ShallowEqual (const XMLNode *compare) const
 
- Public Member Functions inherited from tinyxml2::XMLNode
const XMLDocumentGetDocument () const
 Get the XMLDocument that owns this XMLNode.
 
XMLDocumentGetDocument ()
 Get the XMLDocument that owns this XMLNode.
 
virtual XMLElementToElement ()
 Safely cast to an Element, or null.
 
virtual XMLCommentToComment ()
 Safely cast to a Comment, or null.
 
virtual XMLDocumentToDocument ()
 Safely cast to a Document, or null.
 
virtual XMLDeclarationToDeclaration ()
 Safely cast to a Declaration, or null.
 
virtual XMLUnknownToUnknown ()
 Safely cast to an Unknown, or null.
 
virtual const XMLElementToElement () const
 
virtual const XMLCommentToComment () const
 
virtual const XMLDocumentToDocument () const
 
virtual const XMLDeclarationToDeclaration () const
 
virtual const XMLUnknownToUnknown () const
 
const char * Value () const
 
void SetValue (const char *val, bool staticMem=false)
 
const XMLNodeParent () const
 Get the parent of this node on the DOM.
 
XMLNodeParent ()
 
bool NoChildren () const
 Returns true if this node has no children.
 
const XMLNodeFirstChild () const
 Get the first child node, or null if none exists.
 
XMLNodeFirstChild ()
 
const XMLElementFirstChildElement (const char *name=0) const
 
XMLElementFirstChildElement (const char *name=0)
 
const XMLNodeLastChild () const
 Get the last child node, or null if none exists.
 
XMLNodeLastChild ()
 
const XMLElementLastChildElement (const char *name=0) const
 
XMLElementLastChildElement (const char *name=0)
 
const XMLNodePreviousSibling () const
 Get the previous (left) sibling node of this node.
 
XMLNodePreviousSibling ()
 
const XMLElementPreviousSiblingElement (const char *name=0) const
 Get the previous (left) sibling element of this node, with an optionally supplied name.
 
XMLElementPreviousSiblingElement (const char *name=0)
 
const XMLNodeNextSibling () const
 Get the next (right) sibling node of this node.
 
XMLNodeNextSibling ()
 
const XMLElementNextSiblingElement (const char *name=0) const
 Get the next (right) sibling element of this node, with an optionally supplied name.
 
XMLElementNextSiblingElement (const char *name=0)
 
XMLNodeInsertEndChild (XMLNode *addThis)
 
XMLNodeLinkEndChild (XMLNode *addThis)
 
XMLNodeInsertFirstChild (XMLNode *addThis)
 
XMLNodeInsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
 
void DeleteChildren ()
 
void DeleteChild (XMLNode *node)
 
void SetUserData (void *userData)
 
void * GetUserData () const
 

Protected Member Functions

 XMLText (XMLDocument *doc)
 
virtual ~XMLText ()
 
char * ParseDeep (char *, StrPair *endTag)
 
- Protected Member Functions inherited from tinyxml2::XMLNode
 XMLNode (XMLDocument *)
 
virtual ~XMLNode ()
 

Private Member Functions

 XMLText (const XMLText &)
 
XMLTextoperator= (const XMLText &)
 

Private Attributes

bool _isCData
 

Friends

class XMLDocument
 

Additional Inherited Members

- Protected Attributes inherited from tinyxml2::XMLNode
XMLDocument_document
 
XMLNode_parent
 
StrPair _value
 
XMLNode_firstChild
 
XMLNode_lastChild
 
XMLNode_prev
 
XMLNode_next
 
void * _userData
 

Detailed Description

XML text.

Note that a text node can have child element nodes, for example:
@verbatim 
<root>This is <b>bold</b></root>

A text node can have 2 ways to output the next. "normal" output and CDATA. It will default to the mode it was parsed from the XML file and you generally want to leave it alone, but you can change the output mode with SetCData() and query it with CData().

Definition at line 930 of file tinyxml2.h.

View newest version in sPHENIX GitHub at line 930 of file tinyxml2.h

Constructor & Destructor Documentation

tinyxml2::XMLText::XMLText ( XMLDocument doc)
inlineprotected

Definition at line 956 of file tinyxml2.h.

View newest version in sPHENIX GitHub at line 956 of file tinyxml2.h

virtual tinyxml2::XMLText::~XMLText ( )
inlineprotectedvirtual

Definition at line 957 of file tinyxml2.h.

View newest version in sPHENIX GitHub at line 957 of file tinyxml2.h

tinyxml2::XMLText::XMLText ( const XMLText )
private

Member Function Documentation

bool tinyxml2::XMLText::Accept ( XMLVisitor visitor) const
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();

Implements tinyxml2::XMLNode.

Definition at line 1126 of file tinyxml2.cc.

View newest version in sPHENIX GitHub at line 1126 of file tinyxml2.cc

References TIXMLASSERT, and tinyxml2::XMLVisitor::Visit().

+ Here is the call graph for this function:

bool tinyxml2::XMLText::CData ( ) const
inline

Returns true if this is a CDATA text element.

Definition at line 948 of file tinyxml2.h.

View newest version in sPHENIX GitHub at line 948 of file tinyxml2.h

Referenced by ParseDeep(), ShallowClone(), and tinyxml2::XMLPrinter::Visit().

+ Here is the caller graph for this function:

XMLText& tinyxml2::XMLText::operator= ( const XMLText )
private
char * tinyxml2::XMLText::ParseDeep ( char *  p,
StrPair endTag 
)
protectedvirtual
void tinyxml2::XMLText::SetCData ( bool  isCData)
inline

Declare whether this should be CDATA or standard text.

Definition at line 944 of file tinyxml2.h.

View newest version in sPHENIX GitHub at line 944 of file tinyxml2.h

Referenced by ShallowClone().

+ Here is the caller graph for this function:

XMLNode * tinyxml2::XMLText::ShallowClone ( XMLDocument document) const
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.

Implements tinyxml2::XMLNode.

Definition at line 1108 of file tinyxml2.cc.

View newest version in sPHENIX GitHub at line 1108 of file tinyxml2.cc

References tinyxml2::XMLNode::_document, CData(), tinyxml2::XMLDocument::NewText(), SetCData(), text(), and tinyxml2::XMLNode::Value().

+ Here is the call graph for this function:

bool tinyxml2::XMLText::ShallowEqual ( const XMLNode compare) const
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.

Implements tinyxml2::XMLNode.

Definition at line 1119 of file tinyxml2.cc.

View newest version in sPHENIX GitHub at line 1119 of file tinyxml2.cc

References tinyxml2::XMLUtil::StringEqual(), text(), tinyxml2::XMLNode::ToText(), and tinyxml2::XMLNode::Value().

+ Here is the call graph for this function:

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

Safely cast to Text, or null.

Reimplemented from tinyxml2::XMLNode.

Definition at line 936 of file tinyxml2.h.

View newest version in sPHENIX GitHub at line 936 of file tinyxml2.h

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

Reimplemented from tinyxml2::XMLNode.

Definition at line 939 of file tinyxml2.h.

View newest version in sPHENIX GitHub at line 939 of file tinyxml2.h

Friends And Related Function Documentation

friend class XMLDocument
friend

Definition at line 932 of file tinyxml2.h.

View newest version in sPHENIX GitHub at line 932 of file tinyxml2.h

Member Data Documentation

bool tinyxml2::XMLText::_isCData
private

Definition at line 962 of file tinyxml2.h.

View newest version in sPHENIX GitHub at line 962 of file tinyxml2.h


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