rospack_tinyxml::TiXmlDeclaration Class Reference

#include <tinyxml.h>

Inheritance diagram for rospack_tinyxml::TiXmlDeclaration:

Public Member Functions
virtual bool	Accept (TiXmlVisitor *visitor) const
virtual TiXmlNode *	Clone () const
	Creates a copy of this Declaration and returns it.
const char *	Encoding () const
	Encoding. Will return an empty string if none was found.
void	operator= (const TiXmlDeclaration &copy)
virtual const char *	Parse (const char p, TiXmlParsingData data, TiXmlEncoding encoding)
virtual void	Print (FILE *cfile, int depth) const
virtual void	Print (FILE cfile, int depth, TIXML_STRING str) const
const char *	Standalone () const
	Is this a standalone document?
	TiXmlDeclaration (const TiXmlDeclaration &copy)
	TiXmlDeclaration (const char _version, const char _encoding, const char *_standalone)
	Construct.
	TiXmlDeclaration ()
	Construct an empty declaration.
virtual TiXmlDeclaration *	ToDeclaration ()
	Cast to a more defined type. Will return null not of the requested type.
virtual const TiXmlDeclaration *	ToDeclaration () const
	Cast to a more defined type. Will return null not of the requested type.
const char *	Version () const
	Version. Will return an empty string if none was found.
virtual	~TiXmlDeclaration ()
Protected Member Functions
void	CopyTo (TiXmlDeclaration *target) const
Private Attributes
TIXML_STRING	encoding
TIXML_STRING	standalone
TIXML_STRING	version

Detailed Description

In correct XML the declaration is the first entry in the file.

		<?xml version="1.0" standalone="yes"?>

TinyXml will happily read or write files without a declaration, however. There are 3 possible attributes to the declaration: version, encoding, and standalone.

Note: In this version of the code, the attributes are handled as special cases, not generic attributes, simply because there can only be at most 3 and they are always the same.

Definition at line 1292 of file tinyxml.h.

Constructor & Destructor Documentation

rospack_tinyxml::TiXmlDeclaration::TiXmlDeclaration ( ) [inline]

Construct an empty declaration.

Definition at line 1296 of file tinyxml.h.

rospack_tinyxml::TiXmlDeclaration::TiXmlDeclaration	(	const char *	_version,
		const char *	_encoding,
		const char *	_standalone
	)

Construct.

Definition at line 1383 of file tinyxml.cpp.

rospack_tinyxml::TiXmlDeclaration::TiXmlDeclaration ( const TiXmlDeclaration & copy )

Definition at line 1407 of file tinyxml.cpp.

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

Definition at line 1313 of file tinyxml.h.

Member Function Documentation

bool rospack_tinyxml::TiXmlDeclaration::Accept ( TiXmlVisitor * visitor ) const [virtual]

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

Implements rospack_tinyxml::TiXmlNode.

Definition at line 1453 of file tinyxml.cpp.

TiXmlNode * rospack_tinyxml::TiXmlDeclaration::Clone ( ) const [virtual]

Creates a copy of this Declaration and returns it.

Implements rospack_tinyxml::TiXmlNode.

Definition at line 1459 of file tinyxml.cpp.

void rospack_tinyxml::TiXmlDeclaration::CopyTo ( TiXmlDeclaration * target ) const [protected]

Definition at line 1443 of file tinyxml.cpp.

const char* rospack_tinyxml::TiXmlDeclaration::Encoding ( ) const [inline]

Encoding. Will return an empty string if none was found.

Definition at line 1318 of file tinyxml.h.

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

Definition at line 1414 of file tinyxml.cpp.

const char * rospack_tinyxml::TiXmlDeclaration::Parse	(	const char *	p,
		TiXmlParsingData *	data,
		TiXmlEncoding	encoding
	)			`[virtual]`

Implements rospack_tinyxml::TiXmlBase.

Definition at line 1574 of file tinyxmlparser.cpp.

virtual void rospack_tinyxml::TiXmlDeclaration::Print	(	FILE *	cfile,
		int	depth
	)			const `[inline, virtual]`

All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

Implements rospack_tinyxml::TiXmlBase.

Definition at line 1326 of file tinyxml.h.