Public Member Functions
rospack_tinyxml::TiXmlVisitor Class Reference

#include <tinyxml.h>

Inheritance diagram for rospack_tinyxml::TiXmlVisitor:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual bool Visit (const TiXmlDeclaration &)
 Visit a declaration.
virtual bool Visit (const TiXmlText &)
 Visit a text node.
virtual bool Visit (const TiXmlComment &)
 Visit a comment node.
virtual bool Visit (const TiXmlUnknown &)
 Visit an unknow node.
virtual bool VisitEnter (const TiXmlDocument &)
 Visit a document.
virtual bool VisitEnter (const TiXmlElement &, const TiXmlAttribute *)
 Visit an element.
virtual bool VisitExit (const TiXmlDocument &)
 Visit a document.
virtual bool VisitExit (const TiXmlElement &)
 Visit an element.
virtual ~TiXmlVisitor ()

Detailed Description

If you call the Accept() method, it requires being passed a TiXmlVisitor class to handle callbacks. For nodes that contain other nodes (Document, Element) you will get called with a VisitEnter/VisitExit pair. Nodes that are always leaves are simple called with Visit().

If you return 'true' from a Visit method, recursive parsing will continue. If you return false, no children of this node or its sibilings will be Visited.

All flavors of Visit methods have a default implementation that returns 'true' (continue visiting). You need to only override methods that are interesting to you.

Generally Accept() is called on the TiXmlDocument, although all nodes suppert Visiting.

You should never change the document from a callback.

See also:
TiXmlNode::Accept()

Definition at line 143 of file tinyxml.h.


Constructor & Destructor Documentation

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

Definition at line 146 of file tinyxml.h.


Member Function Documentation

virtual bool rospack_tinyxml::TiXmlVisitor::Visit ( const TiXmlDeclaration ) [inline, virtual]

Visit a declaration.

Reimplemented in rospack_tinyxml::TiXmlPrinter.

Definition at line 159 of file tinyxml.h.

virtual bool rospack_tinyxml::TiXmlVisitor::Visit ( const TiXmlText ) [inline, virtual]

Visit a text node.

Reimplemented in rospack_tinyxml::TiXmlPrinter.

Definition at line 161 of file tinyxml.h.

virtual bool rospack_tinyxml::TiXmlVisitor::Visit ( const TiXmlComment ) [inline, virtual]

Visit a comment node.

Reimplemented in rospack_tinyxml::TiXmlPrinter.

Definition at line 163 of file tinyxml.h.

virtual bool rospack_tinyxml::TiXmlVisitor::Visit ( const TiXmlUnknown ) [inline, virtual]

Visit an unknow node.

Reimplemented in rospack_tinyxml::TiXmlPrinter.

Definition at line 165 of file tinyxml.h.

virtual bool rospack_tinyxml::TiXmlVisitor::VisitEnter ( const TiXmlDocument ) [inline, virtual]

Visit a document.

Reimplemented in rospack_tinyxml::TiXmlPrinter.

Definition at line 149 of file tinyxml.h.

virtual bool rospack_tinyxml::TiXmlVisitor::VisitEnter ( const TiXmlElement ,
const TiXmlAttribute  
) [inline, virtual]

Visit an element.

Reimplemented in rospack_tinyxml::TiXmlPrinter.

Definition at line 154 of file tinyxml.h.

virtual bool rospack_tinyxml::TiXmlVisitor::VisitExit ( const TiXmlDocument ) [inline, virtual]

Visit a document.

Reimplemented in rospack_tinyxml::TiXmlPrinter.

Definition at line 151 of file tinyxml.h.

virtual bool rospack_tinyxml::TiXmlVisitor::VisitExit ( const TiXmlElement ) [inline, virtual]

Visit an element.

Reimplemented in rospack_tinyxml::TiXmlPrinter.

Definition at line 156 of file tinyxml.h.


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


rospack
Author(s): Brian Gerkey/gerkey@willowgarage.com, Morgan Quigley/mquigley@cs.stanford.edu
autogenerated on Fri Jan 3 2014 11:51:41