DataDirector API
Public Member Functions | Protected Member Functions | List of all members
TiXmlDocument Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlDocument:
TiXmlNode TiXmlBase

Public Member Functions

 TiXmlDocument ()
 Create an empty document, that has no name.
 
 TiXmlDocument (const char *documentName)
 Create a document with a name. The name of the document is also the filename of the xml.
 
bool LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
 
bool SaveFile () const
 Save a file using the current document value. Returns true if successful.
 
bool LoadFile (const char *filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
 Load a file using the given filename. Returns true if successful.
 
bool SaveFile (const char *filename) const
 Save a file using the given filename. Returns true if successful.
 
virtual const char * Parse (const char *p, TiXmlParsingData *data=0, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
 
const TiXmlElementRootElement () const
 
bool Error () const
 
const char * ErrorDesc () const
 Contains a textual (english) description of the error if one occurs.
 
const int ErrorId () const
 
int ErrorRow ()
 
int ErrorCol ()
 The column where the error occured. See ErrorRow()
 
void SetTabSize (int _tabsize)
 
void ClearError ()
 
void Print () const
 
virtual void Print (FILE *cfile, int depth=0) const
 Print this Document to a FILE stream.
 
- Public Member Functions inherited from TiXmlNode
const char * Value () const
 
void SetValue (const char *_value)
 
void Clear ()
 Delete all the children of this node. Does not affect 'this'.
 
TiXmlNodeParent ()
 One step up the DOM.
 
const TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children.
 
const TiXmlNodeFirstChild (const char *value) const
 The first child of this node with the matching 'value'. Will be null if none found.
 
TiXmlNodeFirstChild (const char *value)
 The first child of this node with the matching 'value'. Will be null if none found.
 
TiXmlNodeLastChild ()
 The last child of this node. Will be null if there are no children.
 
TiXmlNodeLastChild (const char *value)
 The last child of this node matching 'value'. Will be null if there are no children.
 
const TiXmlNodeIterateChildren (const TiXmlNode *previous) const
 
const TiXmlNodeIterateChildren (const char *value, const TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
 
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
 
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
 
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
 
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
 
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
 
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
 
const TiXmlNodePreviousSibling () const
 Navigate to a sibling node.
 
const TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node.
 
const TiXmlNodeNextSibling () const
 Navigate to a sibling node.
 
const TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
 
const TiXmlElementNextSiblingElement () const
 
const TiXmlElementNextSiblingElement (const char *) const
 
const TiXmlElementFirstChildElement () const
 Convenience function to get through elements.
 
const TiXmlElementFirstChildElement (const char *value) const
 Convenience function to get through elements.
 
virtual int Type () const
 
const TiXmlDocumentGetDocument () const
 
bool NoChildren () const
 Returns true if this node has no children.
 
const TiXmlDocumentToDocument () const
 Cast to a more defined type. Will return null not of the requested type.
 
const TiXmlElementToElement () const
 Cast to a more defined type. Will return null not of the requested type.
 
const TiXmlCommentToComment () const
 Cast to a more defined type. Will return null not of the requested type.
 
const TiXmlUnknownToUnknown () const
 Cast to a more defined type. Will return null not of the requested type.
 
const TiXmlTextToText () const
 Cast to a more defined type. Will return null not of the requested type.
 
const TiXmlDeclarationToDeclaration () const
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlDocumentToDocument ()
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlElementToElement ()
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlCommentToComment ()
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlUnknownToUnknown ()
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlTextToText ()
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlDeclarationToDeclaration ()
 Cast to a more defined type. Will return null not of the requested type.
 
- Public Member Functions inherited from TiXmlBase
int Row () const
 
int Column () const
 See Row()
 

Protected Member Functions

virtual TiXmlNodeClone () const
 

Additional Inherited Members

- Public Types inherited from TiXmlNode
enum  NodeType
 
- Static Public Member Functions inherited from TiXmlBase
static void SetCondenseWhiteSpace (bool condense)
 
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting.
 
- Protected Attributes inherited from TiXmlBase
void * userData
 Field containing a generic user pointer.
 

Detailed Description

Always the top level node. A document binds together all the XML pieces. It can be saved, loaded, and printed to the screen. The 'value' of a document node is the xml file name.

Member Function Documentation

void ClearError ( )
inline

If you have handled the error, it can be reset with this call. The error state is automatically cleared if you Parse a new XML block.

virtual TiXmlNode* Clone ( ) const
protectedvirtual

Create an exact duplicate of this node and return it. The memory must be deleted by the caller.

Implements TiXmlNode.

bool Error ( ) const
inline

If an error occurs, Error will be set to true. Also,

  • The ErrorId() will contain the integer identifier of the error (not generally useful)
  • The ErrorDesc() method will return the name of the error. (very useful)
  • The ErrorRow() and ErrorCol() will return the location of the error (if known)
const int ErrorId ( ) const
inline

Generally, you probably want the error string ( ErrorDesc() ). But if you prefer the ErrorId, this function will fetch it.

int ErrorRow ( )
inline

Returns the location (if known) of the error. The first column is column 1, and the first row is row 1. A value of 0 means the row and column wasn't applicable (memory errors, for example, have no row/column) or the parser lost the error. (An error in the error reporting, in that case.)

See also
SetTabSize, Row, Column
bool LoadFile ( TiXmlEncoding  encoding = TIXML_DEFAULT_ENCODING)

Load a file using the current document value. Returns true if successful. Will delete any existing document data before loading.

virtual const char* Parse ( const char *  p,
TiXmlParsingData *  data = 0,
TiXmlEncoding  encoding = TIXML_DEFAULT_ENCODING 
)
virtual

Parse the given null terminated block of xml data. Passing in an encoding to this method (either TIXML_ENCODING_LEGACY or TIXML_ENCODING_UTF8 will force TinyXml to use that encoding, regardless of what TinyXml might otherwise try to detect.

Implements TiXmlBase.

void Print ( ) const
inline

Dump the document to standard out.

const TiXmlElement* RootElement ( ) const
inline

Get the root element – the only top level element – of the document. In well formed XML, there should only be one. TinyXml is tolerant of multiple elements at the document level.

void SetTabSize ( int  _tabsize)
inline

By calling this method, with a tab size greater than 0, the row and column of each node and attribute is stored when the file is loaded. Very useful for tracking the DOM back in to the source file.

The tab size is required for calculating the location of nodes. If not set, the default of 4 is used. The tabsize is set per document. Setting the tabsize to 0 disables row/column tracking.

Note that row and column tracking is not supported when using operator>>.

The tab size needs to be enabled before the parse or load. Correct usage:

TiXmlDocument doc;
doc.SetTabSize( 8 );
doc.Load( "myfile.xml" );
See also
Row, Column

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