eXperiment robotics framework

TiXmlDocument Class Reference

Always the top level node. More...

#include <tinyxml.h>

Inheritance diagram for TiXmlDocument:

Inheritance graph
[legend]
Collaboration diagram for TiXmlDocument:

Collaboration graph
[legend]

List of all members.

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.
 TiXmlDocument (const std::string &documentName)
 Constructor.
 TiXmlDocument (const TiXmlDocument &copy)
void operator= (const TiXmlDocument &copy)
virtual ~TiXmlDocument ()
bool LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
 Load a file using the current document value.
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.
bool LoadFile (FILE *, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
 Load a file using the given FILE*.
bool SaveFile (FILE *) const
 Save a file using the given FILE*. Returns true if successful.
bool LoadFile (const std::string &filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
bool SaveFile (const std::string &filename) const
 < STL std::string version.
virtual const char * Parse (const char *p, TiXmlParsingData *data=0, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
 Parse the given null terminated block of xml data.
const TiXmlElementRootElement () const
 Get the root element -- the only top level element -- of the document.
TiXmlElementRootElement ()
bool Error () const
 If an error occurs, Error will be set to true.
const char * ErrorDesc () const
 Contains a textual (english) description of the error if one occurs.
int ErrorId () const
 Generally, you probably want the error string ( ErrorDesc() ).
int ErrorRow () const
 Returns the location (if known) of the error.
int ErrorCol () const
 The column where the error occured. See ErrorRow().
void SetTabSize (int _tabsize)
 SetTabSize() allows the error reporting functions (ErrorRow() and ErrorCol()) to report the correct values for row and column.
int TabSize () const
void ClearError ()
 If you have handled the error, it can be reset with this call.
void Print () const
 Write the document to standard out using formatted printing ("pretty print").
virtual void Print (FILE *cfile, int depth=0) const
 Print this Document to a FILE stream.
void SetError (int err, const char *errorLocation, TiXmlParsingData *prevData, TiXmlEncoding encoding)
virtual const TiXmlDocumentToDocument () const
 Cast to a more defined type. Will return null not of the requested type.
virtual TiXmlDocumentToDocument ()
 Cast to a more defined type. Will return null not of the requested type.
virtual bool Accept (TiXmlVisitor *content) const
 Walk the XML tree visiting this node and all of its children.

Protected Member Functions

virtual TiXmlNodeClone () const
 Create an exact duplicate of this node and return it.
virtual void StreamIn (std::istream *in, TIXML_STRING *tag)

Private Member Functions

void CopyTo (TiXmlDocument *target) const

Private Attributes

bool error
int errorId
TIXML_STRING errorDesc
int tabsize
TiXmlCursor errorLocation
bool useMicrosoftBOM


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.

Definition at line 1389 of file tinyxml.h.


Constructor & Destructor Documentation

TiXmlDocument::TiXmlDocument (  ) 

Create an empty document, that has no name.

TiXmlDocument::TiXmlDocument ( const char *  documentName  ) 

Create a document with a name. The name of the document is also the filename of the xml.

TiXmlDocument::TiXmlDocument ( const std::string &  documentName  ) 

Constructor.

TiXmlDocument::TiXmlDocument ( const TiXmlDocument copy  ) 

virtual TiXmlDocument::~TiXmlDocument (  )  [inline, virtual]

Definition at line 1405 of file tinyxml.h.


Member Function Documentation

void TiXmlDocument::operator= ( const TiXmlDocument copy  ) 

bool TiXmlDocument::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.

Referenced by LoadFile().

bool TiXmlDocument::SaveFile (  )  const

Save a file using the current document value. Returns true if successful.

Referenced by SaveFile().

bool TiXmlDocument::LoadFile ( const char *  filename,
TiXmlEncoding  encoding = TIXML_DEFAULT_ENCODING 
)

Load a file using the given filename. Returns true if successful.

bool TiXmlDocument::SaveFile ( const char *  filename  )  const

Save a file using the given filename. Returns true if successful.

bool TiXmlDocument::LoadFile ( FILE *  ,
TiXmlEncoding  encoding = TIXML_DEFAULT_ENCODING 
)

Load a file using the given FILE*.

Returns true if successful. Note that this method doesn't stream - the entire object pointed at by the FILE* will be interpreted as an XML file. TinyXML doesn't stream in XML from the current file location. Streaming may be added in the future.

bool TiXmlDocument::SaveFile ( FILE *   )  const

Save a file using the given FILE*. Returns true if successful.

bool TiXmlDocument::LoadFile ( const std::string &  filename,
TiXmlEncoding  encoding = TIXML_DEFAULT_ENCODING 
) [inline]

Parameters:
encoding  STL std::string version.

Definition at line 1428 of file tinyxml.h.

References LoadFile().

bool TiXmlDocument::SaveFile ( const std::string &  filename  )  const [inline]

< STL std::string version.

Definition at line 1434 of file tinyxml.h.

References SaveFile().

virtual const char* TiXmlDocument::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.

const TiXmlElement* TiXmlDocument::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.

Definition at line 1452 of file tinyxml.h.

References TiXmlNode::FirstChildElement().

TiXmlElement* TiXmlDocument::RootElement (  )  [inline]

Definition at line 1453 of file tinyxml.h.

References TiXmlNode::FirstChildElement().

bool TiXmlDocument::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)

Definition at line 1460 of file tinyxml.h.

References error.

const char* TiXmlDocument::ErrorDesc (  )  const [inline]

Contains a textual (english) description of the error if one occurs.

Definition at line 1463 of file tinyxml.h.

References errorDesc.

int TiXmlDocument::ErrorId (  )  const [inline]

Generally, you probably want the error string ( ErrorDesc() ).

But if you prefer the ErrorId, this function will fetch it.

Definition at line 1468 of file tinyxml.h.

References errorId.

int TiXmlDocument::ErrorRow (  )  const [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

Definition at line 1477 of file tinyxml.h.

References errorLocation, and TiXmlCursor::row.

int TiXmlDocument::ErrorCol (  )  const [inline]

The column where the error occured. See ErrorRow().

Definition at line 1478 of file tinyxml.h.

References TiXmlCursor::col, and errorLocation.

void TiXmlDocument::SetTabSize ( int  _tabsize  )  [inline]

SetTabSize() allows the error reporting functions (ErrorRow() and ErrorCol()) to report the correct values for row and column.

It does not change the output or input in any way.

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

Definition at line 1504 of file tinyxml.h.

References tabsize.

int TiXmlDocument::TabSize (  )  const [inline]

Definition at line 1506 of file tinyxml.h.

References tabsize.

void TiXmlDocument::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.

Definition at line 1511 of file tinyxml.h.

References TiXmlCursor::col, error, errorDesc, errorId, errorLocation, and TiXmlCursor::row.

void TiXmlDocument::Print (  )  const [inline]

Write the document to standard out using formatted printing ("pretty print").

Definition at line 1519 of file tinyxml.h.

virtual void TiXmlDocument::Print ( FILE *  cfile,
int  depth = 0 
) const [virtual]

Print this Document to a FILE stream.

Implements TiXmlBase.

void TiXmlDocument::SetError ( int  err,
const char *  errorLocation,
TiXmlParsingData *  prevData,
TiXmlEncoding  encoding 
)

virtual const TiXmlDocument* TiXmlDocument::ToDocument (  )  const [inline, virtual]

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

Definition at line 1532 of file tinyxml.h.

virtual TiXmlDocument* TiXmlDocument::ToDocument (  )  [inline, virtual]

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

Definition at line 1533 of file tinyxml.h.

virtual bool TiXmlDocument::Accept ( TiXmlVisitor content  )  const [virtual]

Walk the XML tree visiting this node and all of its children.

Implements TiXmlNode.

virtual TiXmlNode* TiXmlDocument::Clone (  )  const [protected, virtual]

Create an exact duplicate of this node and return it.

The memory must be deleted by the caller.

Implements TiXmlNode.

virtual void TiXmlDocument::StreamIn ( std::istream *  in,
TIXML_STRING *  tag 
) [protected, virtual]

Implements TiXmlNode.

void TiXmlDocument::CopyTo ( TiXmlDocument target  )  const [private]


Member Data Documentation

bool TiXmlDocument::error [private]

Definition at line 1549 of file tinyxml.h.

Referenced by ClearError(), and Error().

int TiXmlDocument::errorId [private]

Definition at line 1550 of file tinyxml.h.

Referenced by ClearError(), and ErrorId().

TIXML_STRING TiXmlDocument::errorDesc [private]

Definition at line 1551 of file tinyxml.h.

Referenced by ClearError(), and ErrorDesc().

int TiXmlDocument::tabsize [private]

Definition at line 1552 of file tinyxml.h.

Referenced by SetTabSize(), and TabSize().

Definition at line 1553 of file tinyxml.h.

Referenced by ClearError(), ErrorCol(), and ErrorRow().

Definition at line 1554 of file tinyxml.h.


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

The miarn project - written by Joao Xavier