Parse XML to handle element tags and attributes. More...

#include <vtkXMLParser.h>

Inheritance diagram for vtkXMLParser:

Collaboration diagram for vtkXMLParser:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkXMLParser *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual int	Parse ()


virtual void	SetStream (istream *)

virtual istream *	GetStream ()


vtkTypeInt64	TellG ()

void	SeekG (vtkTypeInt64 position)


virtual int	Parse (const char *inputString)

virtual int	Parse (const char *inputString, unsigned int length)


virtual int	InitializeParser ()

virtual int	ParseChunk (const char *inputString, unsigned int length)

virtual int	CleanupParser ()


virtual void	SetFileName (const char *)

virtual char *	GetFileName ()


virtual void	SetIgnoreCharacterData (int)

virtual int	GetIgnoreCharacterData ()


virtual void	SetEncoding (const char *)

virtual char *	GetEncoding ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkXMLParser *	SafeDownCast (vtkObjectBase *o)

static vtkXMLParser *	New ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkXMLParser ()

	~vtkXMLParser ()

virtual int	CreateParser ()

virtual int	ParseXML ()

virtual int	ParsingComplete ()

virtual void	StartElement (const char name, const char *atts)

virtual void	EndElement (const char *name)

virtual void	CharacterDataHandler (const char *data, int length)

virtual void	ReportStrayAttribute (const char element, const char attr, const char *value)

virtual void	ReportMissingAttribute (const char element, const char attr)

virtual void	ReportBadAttribute (const char element, const char attr, const char *value)

virtual void	ReportUnknownElement (const char *element)

virtual void	ReportXmlParseError ()

vtkTypeInt64	GetXMLByteIndex ()

virtual int	ParseBuffer (const char *buffer, unsigned int count)

int	ParseBuffer (const char *buffer)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static int	IsSpace (char c)

Protected Attributes
istream *	Stream

char *	FileName

char *	Encoding

int	ParseError

const char *	InputString

int	InputStringLength

void *	Parser

int	IgnoreCharacterData

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
void	vtkXMLParserStartElement (void , const char , const char **)

void	vtkXMLParserEndElement (void , const char )

void	vtkXMLParserCharacterDataHandler (void , const char , int)

Detailed Description

Parse XML to handle element tags and attributes.

vtkXMLParser reads a stream and parses XML element tags and corresponding attributes. Each element begin tag and its attributes are sent to the StartElement method. Each element end tag is sent to the EndElement method. Subclasses should replace these methods to actually use the tags.

Tests:: vtkXMLParser (Tests)

Definition at line 41 of file vtkXMLParser.h.

Member Typedef Documentation

typedef vtkObject vtkXMLParser::Superclass

Definition at line 44 of file vtkXMLParser.h.

Constructor & Destructor Documentation

vtkXMLParser::vtkXMLParser ( )

protected

vtkXMLParser::~vtkXMLParser ( )

protected

Member Function Documentation

static int vtkXMLParser::IsTypeOf ( const char * type )

static

virtual int vtkXMLParser::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkBlueObeliskDataParser, vtkXMLDataParser, vtkExodusIIReaderParser, vtkLSDynaSummaryParser, and vtkXMLFileReadTester.

static vtkXMLParser* vtkXMLParser::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkXMLParser::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkBlueObeliskDataParser, vtkXMLDataParser, vtkExodusIIReaderParser, vtkLSDynaSummaryParser, and vtkXMLFileReadTester.

vtkXMLParser* vtkXMLParser::NewInstance ( ) const

void vtkXMLParser::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

static vtkXMLParser* vtkXMLParser::New ( )

static

virtual void vtkXMLParser::SetStream ( istream * )

virtual

Get/Set the input stream.

virtual istream* vtkXMLParser::GetStream ( )

virtual

Get/Set the input stream.

vtkTypeInt64 vtkXMLParser::TellG ( )

Used by subclasses and their supporting classes. These methods wrap around the tellg and seekg methods of the input stream to work-around stream bugs on various platforms.

void vtkXMLParser::SeekG ( vtkTypeInt64 position )

Used by subclasses and their supporting classes. These methods wrap around the tellg and seekg methods of the input stream to work-around stream bugs on various platforms.

virtual int vtkXMLParser::Parse ( )

virtual

Parse the XML input.

Reimplemented in vtkXMLDataParser, and vtkBlueObeliskDataParser.

virtual int vtkXMLParser::Parse ( const char * inputString )

virtual

Parse the XML message. If length is specified, parse only the first "length" characters

Reimplemented in vtkXMLDataParser, and vtkBlueObeliskDataParser.

virtual int vtkXMLParser::Parse	(	const char *	inputString,
		unsigned int	length
	)

virtual

Parse the XML message. If length is specified, parse only the first "length" characters

Reimplemented in vtkXMLDataParser, and vtkBlueObeliskDataParser.

virtual int vtkXMLParser::InitializeParser ( )

virtual

When parsing fragments of XML or streaming XML, use the following three methods. InitializeParser method initialize parser but does not perform any actual parsing. ParseChunk parses framgent of XML. This has to match to what was already parsed. CleanupParser finishes parsing. If there were errors, CleanupParser will report them.

virtual int vtkXMLParser::ParseChunk	(	const char *	inputString,
		unsigned int	length
	)

virtual

When parsing fragments of XML or streaming XML, use the following three methods. InitializeParser method initialize parser but does not perform any actual parsing. ParseChunk parses framgent of XML. This has to match to what was already parsed. CleanupParser finishes parsing. If there were errors, CleanupParser will report them.

virtual int vtkXMLParser::CleanupParser ( )

virtual

When parsing fragments of XML or streaming XML, use the following three methods. InitializeParser method initialize parser but does not perform any actual parsing. ParseChunk parses framgent of XML. This has to match to what was already parsed. CleanupParser finishes parsing. If there were errors, CleanupParser will report them.

virtual void vtkXMLParser::SetFileName ( const char * )

virtual

Set and get file name.

Reimplemented in vtkXMLFileReadTester.

virtual char* vtkXMLParser::GetFileName ( )

virtual

Set and get file name.

Reimplemented in vtkXMLFileReadTester.

virtual void vtkXMLParser::SetIgnoreCharacterData ( int )

virtual

If this is off (the default), CharacterDataHandler will be called to process text within XML Elements. If this is on, the text will be ignored.

virtual int vtkXMLParser::GetIgnoreCharacterData ( )

virtual

If this is off (the default), CharacterDataHandler will be called to process text within XML Elements. If this is on, the text will be ignored.

virtual void vtkXMLParser::SetEncoding ( const char * )

virtual

Set and get the encoding the parser should expect (NULL defaults to Expat's own default encoder, i.e UTF-8). This should be set before parsing (i.e. a call to Parse()) or even initializing the parser (i.e. a call to InitializeParser())

virtual char* vtkXMLParser::GetEncoding ( )

virtual

Set and get the encoding the parser should expect (NULL defaults to Expat's own default encoder, i.e UTF-8). This should be set before parsing (i.e. a call to Parse()) or even initializing the parser (i.e. a call to InitializeParser())

virtual int vtkXMLParser::CreateParser ( )

protectedvirtual

virtual int vtkXMLParser::ParseXML ( )

protectedvirtual

virtual int vtkXMLParser::ParsingComplete ( )

protectedvirtual

Reimplemented in vtkXMLDataParser, and vtkXMLFileReadTester.

virtual void vtkXMLParser::StartElement	(	const char *	name,
		const char **	atts
	)

protectedvirtual

Reimplemented in vtkXMLDataParser, vtkExodusIIReaderParser, vtkBlueObeliskDataParser, vtkXMLFileReadTester, and vtkLSDynaSummaryParser.

virtual void vtkXMLParser::EndElement ( const char * name )

protectedvirtual

Reimplemented in vtkXMLDataParser, vtkExodusIIReaderParser, vtkBlueObeliskDataParser, and vtkLSDynaSummaryParser.

virtual void vtkXMLParser::CharacterDataHandler	(	const char *	data,
		int	length
	)

protectedvirtual

Reimplemented in vtkXMLDataParser, vtkBlueObeliskDataParser, and vtkLSDynaSummaryParser.

virtual void vtkXMLParser::ReportStrayAttribute	(	const char *	element,
		const char *	attr,
		const char *	value
	)

protectedvirtual

Reimplemented in vtkXMLFileReadTester.

virtual void vtkXMLParser::ReportMissingAttribute	(	const char *	element,
		const char *	attr
	)

protectedvirtual

Reimplemented in vtkXMLFileReadTester.

virtual void vtkXMLParser::ReportBadAttribute	(	const char *	element,
		const char *	attr,
		const char *	value
	)

protectedvirtual

Reimplemented in vtkXMLFileReadTester.

virtual void vtkXMLParser::ReportUnknownElement ( const char * element )

protectedvirtual

Reimplemented in vtkXMLFileReadTester.

virtual void vtkXMLParser::ReportXmlParseError ( )

protectedvirtual

Reimplemented in vtkXMLFileReadTester.

vtkTypeInt64 vtkXMLParser::GetXMLByteIndex ( )

protected

virtual int vtkXMLParser::ParseBuffer	(	const char *	buffer,
		unsigned int	count
	)

protectedvirtual

Reimplemented in vtkXMLDataParser.

int vtkXMLParser::ParseBuffer ( const char * buffer )

protected

static int vtkXMLParser::IsSpace ( char c )

staticprotected

Friends And Related Function Documentation

void vtkXMLParserStartElement	(	void *	,
		const char *	,
		const char **
	)

friend

void vtkXMLParserEndElement	(	void *	,
		const char *
	)

friend

void vtkXMLParserCharacterDataHandler	(	void *	parser,
		const char *	data,
		int	length
	)

friend

Definition at line 205 of file vtkXMLParser.h.

Member Data Documentation

istream* vtkXMLParser::Stream

protected

Definition at line 114 of file vtkXMLParser.h.

char* vtkXMLParser::FileName

protected

Definition at line 117 of file vtkXMLParser.h.

char* vtkXMLParser::Encoding

protected

Definition at line 120 of file vtkXMLParser.h.

int vtkXMLParser::ParseError

protected

Definition at line 124 of file vtkXMLParser.h.

const char* vtkXMLParser::InputString

protected

Definition at line 127 of file vtkXMLParser.h.

int vtkXMLParser::InputStringLength

protected

Definition at line 128 of file vtkXMLParser.h.

void* vtkXMLParser::Parser

protected

Definition at line 131 of file vtkXMLParser.h.

int vtkXMLParser::IgnoreCharacterData

protected

Definition at line 196 of file vtkXMLParser.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/IO/XMLParser/vtkXMLParser.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation