rospack_tinyxml::TiXmlDocument Class Reference

#include <tinyxml.h>

Inheritance diagram for rospack_tinyxml::TiXmlDocument:

Public Member Functions
virtual bool	Accept (TiXmlVisitor *content) const
void	ClearError ()
bool	Error () const
int	ErrorCol () const
	The column where the error occured. See ErrorRow().
const char *	ErrorDesc () const
	Contains a textual (english) description of the error if one occurs.
int	ErrorId () const
int	ErrorRow () const
bool	LoadFile (FILE *, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
bool	LoadFile (const char *filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
	Load a file using the given filename. Returns true if successful.
bool	LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
void	operator= (const TiXmlDocument &copy)
virtual const char *	Parse (const char p, TiXmlParsingData data=0, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
virtual void	Print (FILE *cfile, int depth=0) const
	Print this Document to a FILE stream.
void	Print () const
TiXmlElement *	RootElement ()
const TiXmlElement *	RootElement () const
bool	SaveFile (FILE *) const
	Save a file using the given FILE*. Returns true if successful.
bool	SaveFile (const char *filename) const
	Save a file using the given filename. Returns true if successful.
bool	SaveFile () const
	Save a file using the current document value. Returns true if successful.
void	SetError (int err, const char errorLocation, TiXmlParsingData prevData, TiXmlEncoding encoding)
void	SetTabSize (int _tabsize)
int	TabSize () const
	TiXmlDocument (const TiXmlDocument &copy)
	TiXmlDocument (const char *documentName)
	Create a document with a name. The name of the document is also the filename of the xml.
	TiXmlDocument ()
	Create an empty document, that has no name.
virtual TiXmlDocument *	ToDocument ()
	Cast to a more defined type. Will return null not of the requested type.
virtual const TiXmlDocument *	ToDocument () const
	Cast to a more defined type. Will return null not of the requested type.
virtual	~TiXmlDocument ()
Protected Member Functions
virtual TiXmlNode *	Clone () const
Private Member Functions
void	CopyTo (TiXmlDocument *target) const
Private Attributes
bool	error
TIXML_STRING	errorDesc
int	errorId
TiXmlCursor	errorLocation
int	tabsize
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 1400 of file tinyxml.h.

Constructor & Destructor Documentation

rospack_tinyxml::TiXmlDocument::TiXmlDocument ( )

Create an empty document, that has no name.

Definition at line 885 of file tinyxml.cpp.

rospack_tinyxml::TiXmlDocument::TiXmlDocument ( const char * documentName )

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

Definition at line 892 of file tinyxml.cpp.

rospack_tinyxml::TiXmlDocument::TiXmlDocument ( const TiXmlDocument & copy )

Definition at line 912 of file tinyxml.cpp.

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

Definition at line 1416 of file tinyxml.h.

Member Function Documentation

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

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

Implements rospack_tinyxml::TiXmlNode.

Definition at line 1161 of file tinyxml.cpp.

void rospack_tinyxml::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 1522 of file tinyxml.h.

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

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

Implements rospack_tinyxml::TiXmlNode.

Definition at line 1139 of file tinyxml.cpp.

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

Definition at line 1120 of file tinyxml.cpp.

bool rospack_tinyxml::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 1471 of file tinyxml.h.

int rospack_tinyxml::TiXmlDocument::ErrorCol ( ) const [inline]

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

Definition at line 1489 of file tinyxml.h.

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

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

Definition at line 1474 of file tinyxml.h.

int rospack_tinyxml::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 1479 of file tinyxml.h.

int rospack_tinyxml::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 1488 of file tinyxml.h.

bool rospack_tinyxml::TiXmlDocument::LoadFile	(	FILE *	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.

Definition at line 974 of file tinyxml.cpp.

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

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

Definition at line 946 of file tinyxml.cpp.

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

Definition at line 925 of file tinyxml.cpp.

void rospack_tinyxml::TiXmlDocument::operator= ( const TiXmlDocument & copy )

Definition at line 918 of file tinyxml.cpp.

const char * rospack_tinyxml::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 rospack_tinyxml::TiXmlBase.

Definition at line 706 of file tinyxmlparser.cpp.

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

Print this Document to a FILE stream.

Implements rospack_tinyxml::TiXmlBase.

Definition at line 1150 of file tinyxml.cpp.

void rospack_tinyxml::TiXmlDocument::Print ( ) const [inline]

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

Definition at line 1530 of file tinyxml.h.

TiXmlElement* rospack_tinyxml::TiXmlDocument::RootElement ( ) [inline]

Definition at line 1464 of file tinyxml.h.

const TiXmlElement* rospack_tinyxml::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 1463 of file tinyxml.h.

bool rospack_tinyxml::TiXmlDocument::SaveFile ( FILE * fp ) const

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

Definition at line 1103 of file tinyxml.cpp.

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

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

Definition at line 1089 of file tinyxml.cpp.

bool rospack_tinyxml::TiXmlDocument::SaveFile ( ) const

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

Definition at line 934 of file tinyxml.cpp.

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

Definition at line 800 of file tinyxmlparser.cpp.

void rospack_tinyxml::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 1515 of file tinyxml.h.

int rospack_tinyxml::TiXmlDocument::TabSize ( ) const [inline]

Definition at line 1517 of file tinyxml.h.

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

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

Reimplemented from rospack_tinyxml::TiXmlNode.

Definition at line 1544 of file tinyxml.h.

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

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

Reimplemented from rospack_tinyxml::TiXmlNode.

Definition at line 1543 of file tinyxml.h.

Member Data Documentation

bool rospack_tinyxml::TiXmlDocument::error [private]

Definition at line 1560 of file tinyxml.h.

TIXML_STRING rospack_tinyxml::TiXmlDocument::errorDesc [private]

Definition at line 1562 of file tinyxml.h.

int rospack_tinyxml::TiXmlDocument::errorId [private]

Definition at line 1561 of file tinyxml.h.

TiXmlCursor rospack_tinyxml::TiXmlDocument::errorLocation [private]

Definition at line 1564 of file tinyxml.h.

int rospack_tinyxml::TiXmlDocument::tabsize [private]

Definition at line 1563 of file tinyxml.h.

bool rospack_tinyxml::TiXmlDocument::useMicrosoftBOM [private]

Definition at line 1565 of file tinyxml.h.

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

rospack_tinyxml::TiXmlDocument Class Reference

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation