Jetson Inference: tinyxml2::XMLDocument Class Reference

| | Jetson Inference

DNN Vision Library |

Classes | Public Member Functions | Static Public Member Functions | Friends | List of all members

tinyxml2::XMLDocument Class Reference

A Document binds together all the functionality. More...

#include <xml.h>

Inheritance diagram for tinyxml2::XMLDocument:

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

A Document binds together all the functionality.

It can be saved, loaded, and printed to the screen. All Nodes are connected and allocated to a Document. If the Document is deleted, all its Nodes are also deleted.

Constructor & Destructor Documentation

◆XMLDocument()

constructor

◆~XMLDocument()

| tinyxml2::XMLDocument::~XMLDocument | ( | | ) | |

Member Function Documentation

◆Accept()

| 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](classtinyxml2_1_1XMLVisitor.html "Implements the interface to the "Visitor pattern" (see the Accept() method.) If you call the Accept()...") 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.

◆Clear()

| void tinyxml2::XMLDocument::Clear | ( | | ) | |

Clear the document, resetting it to the initial state.

◆ClearError()

| void tinyxml2::XMLDocument::ClearError | ( | | ) | |

| inline |

◆DeepCopy()

Copies this document to a target document.

The target will be completely cleared before the copy. If you want to copy a sub-tree, see XMLNode::DeepClone().

NOTE: that the 'target' must be non-null.

◆DeleteNode()

Delete a node associated with this document.

It will be unlinked from the DOM.

◆Error()

| bool tinyxml2::XMLDocument::Error | ( | | ) | const |

| inline |

Return true if there was an error parsing the document.

◆ErrorID()

| XMLError tinyxml2::XMLDocument::ErrorID | ( | | ) | const |

| inline |

Return the errorID.

◆ErrorIDToName()

| static |

◆ErrorLineNum()

| int tinyxml2::XMLDocument::ErrorLineNum | ( | | ) | const |

| inline |

Return the line where the error occured, or zero if unknown.

◆ErrorName()

| const char* tinyxml2::XMLDocument::ErrorName | ( | | ) | const |

◆ErrorStr()

| const char* tinyxml2::XMLDocument::ErrorStr | ( | | ) | const |

Returns a "long form" error description.

A hopefully helpful diagnostic with location, line number, and/or additional info.

◆HasBOM()

| bool tinyxml2::XMLDocument::HasBOM | ( | | ) | const |

| inline |

Returns true if this document has a leading Byte Order Mark of UTF8.

◆Identify()

| char* tinyxml2::XMLDocument::Identify | ( | char * | p, | | | | XMLNode ** | node | | | ) | | |

◆LoadFile() [1/2]

Load an XML file from disk.

Returns XML_SUCCESS (0) on success, or an errorID.

◆LoadFile() [2/2]

| XMLError tinyxml2::XMLDocument::LoadFile | ( | FILE * | | ) | |

Load an XML file from disk.

You are responsible for providing and closing the FILE*.

NOTE: The file should be opened as binary ("rb") not text in order for TinyXML-2 to correctly do newline normalization.

Returns XML_SUCCESS (0) on success, or an errorID.

◆MarkInUse()

| void tinyxml2::XMLDocument::MarkInUse | ( | XMLNode * | | ) | |

◆NewComment()

Create a new Comment associated with this Document.

The memory for the Comment is managed by the Document.

◆NewDeclaration()

Create a new Declaration associated with this Document.

The memory for the object is managed by the Document.

If the 'text' param is null, the standard declaration is used.:

<?xml version="1.0" encoding="UTF-8"?>

◆NewElement()

Create a new Element associated with this Document.

The memory for the Element is managed by the Document.

◆NewText()

Create a new Text associated with this Document.

The memory for the Text is managed by the Document.

◆NewUnknown()

Create a new Unknown associated with this Document.

The memory for the object is managed by the Document.

◆Parse()

| XMLError tinyxml2::XMLDocument::Parse | ( | const char * | xml, | | | | size_t | nBytes = (size_t)(-1) | | | ) | | |

Parse an XML file from a character string.

Returns XML_SUCCESS (0) on success, or an errorID.

You may optionally pass in the 'nBytes', which is the number of bytes which will be parsed. If not specified, TinyXML-2 will assume 'xml' points to a null terminated string.

◆Print()

Print the Document.

If the Printer is not provided, it will print to stdout. If you provide Printer, this can print to a file:

XMLPrinter printer( fp );
doc.Print( &printer );

Or you can use a printer to print to memory:

XMLPrinter printer;
doc.Print( &printer );
// printer.CStr() has a const char* to the XML

◆PrintError()

| void tinyxml2::XMLDocument::PrintError | ( | | ) | const |

A (trivial) utility function that prints the [ErrorStr()](classtinyxml2_1_1XMLDocument.html#ad75aa9d32c4e8b300655186808aa9abf "Returns a "long form" error description.") to stdout.

◆ProcessEntities()

| bool tinyxml2::XMLDocument::ProcessEntities | ( | | ) | const |

| inline |

◆RootElement() [1/2]

| XMLElement* tinyxml2::XMLDocument::RootElement | ( | | ) | |

| inline |

Return the root element of DOM.

Equivalent to FirstChildElement(). To get the first node, use FirstChild().

◆RootElement() [2/2]

| const XMLElement* tinyxml2::XMLDocument::RootElement | ( | | ) | const |

| inline |

◆SaveFile() [1/2]

Save the XML file to disk.

Returns XML_SUCCESS (0) on success, or an errorID.

◆SaveFile() [2/2]

| XMLError tinyxml2::XMLDocument::SaveFile | ( | FILE * | fp, | | | | bool | compact = false | | | ) | | |

Save the XML file to disk.

You are responsible for providing and closing the FILE*.

Returns XML_SUCCESS (0) on success, or an errorID.

◆SetBOM()

| inline |

Sets whether to write the BOM when writing the file.

◆ShallowClone()

| inlinevirtual |

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.

◆ShallowEqual()

| inlinevirtual |

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.

◆ToDocument() [1/2]

| virtual XMLDocument* tinyxml2::XMLDocument::ToDocument | ( | | ) | |

| inlinevirtual |

Safely cast to a Document, or null.

Reimplemented from tinyxml2::XMLNode.

◆ToDocument() [2/2]

| virtual const XMLDocument* tinyxml2::XMLDocument::ToDocument | ( | | ) | const |

| inlinevirtual |

Reimplemented from tinyxml2::XMLNode.

◆WhitespaceMode()

| Whitespace tinyxml2::XMLDocument::WhitespaceMode | ( | | ) | const |

| inline |

◆XMLComment

| friend class XMLComment |

| friend |

◆XMLDeclaration

| friend class XMLDeclaration |

| friend |

◆XMLElement

| friend class XMLElement |

| friend |

◆XMLNode

| friend class XMLNode |

| friend |

◆XMLText

| friend class XMLText |

| friend |

◆XMLUnknown

| friend class XMLUnknown |

| friend |

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

jetson-utils/xml.h
tinyxml2
XMLDocument
Generated on Tue Mar 28 2023 14:27:58 for Jetson Inference by 1.8.17

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆XMLDocument()

◆~XMLDocument()

Member Function Documentation

◆Accept()

◆Clear()

◆ClearError()

◆DeepCopy()

◆DeleteNode()

◆Error()

◆ErrorID()

◆ErrorIDToName()

◆ErrorLineNum()

◆ErrorName()

◆ErrorStr()

◆HasBOM()

◆Identify()

◆LoadFile() [1/2]

◆LoadFile() [2/2]

◆MarkInUse()

◆NewComment()

◆NewDeclaration()

◆NewElement()

◆NewText()

◆NewUnknown()

◆Parse()

◆Print()

◆PrintError()

◆ProcessEntities()

◆RootElement() [1/2]

◆RootElement() [2/2]

◆SaveFile() [1/2]

◆SaveFile() [2/2]

◆SetBOM()

◆ShallowClone()

◆ShallowEqual()

◆ToDocument() [1/2]

◆ToDocument() [2/2]

◆WhitespaceMode()

Friends And Related Function Documentation

◆XMLComment

◆XMLDeclaration

◆XMLElement

◆XMLNode

◆XMLText

◆XMLUnknown