TiXmlDeclaration Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlDeclaration:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual bool Accept (TiXmlVisitor *visitor) const
virtual TiXmlNodeClone () 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 TiXmlDeclarationToDeclaration ()
 Cast to a more defined type. Will return null not of the requested type.
virtual const TiXmlDeclarationToDeclaration () 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 1289 of file tinyxml.h.


Constructor & Destructor Documentation

TiXmlDeclaration::TiXmlDeclaration (  )  [inline]

Construct an empty declaration.

Definition at line 1293 of file tinyxml.h.

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

Construct.

Definition at line 1382 of file tinyxml.cpp.

TiXmlDeclaration::TiXmlDeclaration ( const TiXmlDeclaration copy  ) 

Definition at line 1406 of file tinyxml.cpp.

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

Definition at line 1310 of file tinyxml.h.


Member Function Documentation

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

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

Implements TiXmlNode.

Definition at line 1452 of file tinyxml.cpp.

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

Creates a copy of this Declaration and returns it.

Implements TiXmlNode.

Definition at line 1458 of file tinyxml.cpp.

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

Definition at line 1442 of file tinyxml.cpp.

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

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

Definition at line 1315 of file tinyxml.h.

void TiXmlDeclaration::operator= ( const TiXmlDeclaration copy  ) 

Definition at line 1413 of file tinyxml.cpp.

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

Implements TiXmlBase.

Definition at line 1572 of file tinyxmlparser.cpp.

virtual void 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 TiXmlBase.

Definition at line 1323 of file tinyxml.h.

void TiXmlDeclaration::Print ( FILE *  cfile,
int  depth,
TIXML_STRING *  str 
) const [virtual]

Definition at line 1420 of file tinyxml.cpp.

const char* TiXmlDeclaration::Standalone (  )  const [inline]

Is this a standalone document?

Definition at line 1317 of file tinyxml.h.

virtual TiXmlDeclaration* TiXmlDeclaration::ToDeclaration (  )  [inline, virtual]

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

Reimplemented from TiXmlNode.

Definition at line 1330 of file tinyxml.h.

virtual const TiXmlDeclaration* TiXmlDeclaration::ToDeclaration (  )  const [inline, virtual]

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

Reimplemented from TiXmlNode.

Definition at line 1329 of file tinyxml.h.

const char* TiXmlDeclaration::Version (  )  const [inline]

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

Definition at line 1313 of file tinyxml.h.


Member Data Documentation

TIXML_STRING TiXmlDeclaration::encoding [private]

Definition at line 1346 of file tinyxml.h.

TIXML_STRING TiXmlDeclaration::standalone [private]

Definition at line 1347 of file tinyxml.h.

TIXML_STRING TiXmlDeclaration::version [private]

Definition at line 1345 of file tinyxml.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


rospack
Author(s): Morgan Quigley, Brian Gerkey
autogenerated on Fri Jan 11 09:35:30 2013