RTT::marsh::TiXmlDocument Class Reference

#include <tinyxml.h>

Inheritance diagram for RTT::marsh::TiXmlDocument:

Public Member Functions
void	ClearError ()
bool	Error () const
int	ErrorCol ()
	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 ()
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
virtual void	StreamOut (TIXML_OSTREAM *out) 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 1259 of file tinyxml.h.

Constructor & Destructor Documentation

RTT::marsh::TiXmlDocument::TiXmlDocument ( )

Create an empty document, that has no name.

Definition at line 980 of file tinyxml.cpp.

RTT::marsh::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 987 of file tinyxml.cpp.

RTT::marsh::TiXmlDocument::TiXmlDocument ( const TiXmlDocument & copy )

Definition at line 1007 of file tinyxml.cpp.

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

Definition at line 1275 of file tinyxml.h.

Member Function Documentation

void RTT::marsh::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 1379 of file tinyxml.h.

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

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

Implements RTT::marsh::TiXmlNode.

Definition at line 1231 of file tinyxml.cpp.

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

Definition at line 1216 of file tinyxml.cpp.

bool RTT::marsh::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 1328 of file tinyxml.h.

int RTT::marsh::TiXmlDocument::ErrorCol ( ) [inline]

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

Definition at line 1346 of file tinyxml.h.

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

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

Definition at line 1331 of file tinyxml.h.

int RTT::marsh::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 1336 of file tinyxml.h.

int RTT::marsh::TiXmlDocument::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

Definition at line 1345 of file tinyxml.h.

bool RTT::marsh::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 1071 of file tinyxml.cpp.

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

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

Definition at line 1043 of file tinyxml.cpp.

bool RTT::marsh::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 1020 of file tinyxml.cpp.

void RTT::marsh::TiXmlDocument::operator= ( const TiXmlDocument & copy )

Definition at line 1013 of file tinyxml.cpp.

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

Definition at line 729 of file tinyxmlparser.cpp.

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

Print this Document to a FILE stream.

Implements RTT::marsh::TiXmlBase.

Definition at line 1242 of file tinyxml.cpp.

void RTT::marsh::TiXmlDocument::Print ( ) const [inline]

Dump the document to standard out.

Definition at line 1387 of file tinyxml.h.

TiXmlElement* RTT::marsh::TiXmlDocument::RootElement ( ) [inline]

Definition at line 1321 of file tinyxml.h.

const TiXmlElement* RTT::marsh::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 1320 of file tinyxml.h.

bool RTT::marsh::TiXmlDocument::SaveFile ( FILE * fp ) const

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

Definition at line 1199 of file tinyxml.cpp.

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

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

Definition at line 1185 of file tinyxml.cpp.

bool RTT::marsh::TiXmlDocument::SaveFile ( ) const

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

Definition at line 1032 of file tinyxml.cpp.

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

Definition at line 823 of file tinyxmlparser.cpp.

void RTT::marsh::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 1372 of file tinyxml.h.

void RTT::marsh::TiXmlDocument::StreamOut ( TIXML_OSTREAM * out ) const [protected, virtual]

Implements RTT::marsh::TiXmlBase.

Definition at line 1252 of file tinyxml.cpp.

int RTT::marsh::TiXmlDocument::TabSize ( ) const [inline]

Definition at line 1374 of file tinyxml.h.

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

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

Reimplemented from RTT::marsh::TiXmlNode.

Definition at line 1395 of file tinyxml.h.

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

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

Reimplemented from RTT::marsh::TiXmlNode.

Definition at line 1394 of file tinyxml.h.

Member Data Documentation

bool RTT::marsh::TiXmlDocument::error [private]

Definition at line 1408 of file tinyxml.h.

TIXML_STRING RTT::marsh::TiXmlDocument::errorDesc [private]

Definition at line 1410 of file tinyxml.h.

int RTT::marsh::TiXmlDocument::errorId [private]

Definition at line 1409 of file tinyxml.h.

TiXmlCursor RTT::marsh::TiXmlDocument::errorLocation [private]

Definition at line 1412 of file tinyxml.h.

int RTT::marsh::TiXmlDocument::tabsize [private]

Definition at line 1411 of file tinyxml.h.

bool RTT::marsh::TiXmlDocument::useMicrosoftBOM [private]

Definition at line 1413 of file tinyxml.h.

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

RTT::marsh::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