This is a subclass of vtkXMLParser that constructs a representation of parsed XML using vtkPVXMLElement. More...

#include <vtkPVXMLParser.h>

Inheritance diagram for vtkPVXMLParser:

Collaboration diagram for vtkPVXMLParser:

[legend]

Public Types
typedef vtkXMLParser	Superclass

Public Types inherited from vtkXMLParser
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	PrintXML (ostream &os)
	Write the parsed XML into the output stream. More...

vtkPVXMLElement *	GetRootElement ()
	Get the root element from the XML document. More...


virtual int	GetSuppressErrorMessages ()
	If on, then the Parse method will NOT report an error using vtkErrorMacro. More...

virtual void	SetSuppressErrorMessages (int)
	If on, then the Parse method will NOT report an error using vtkErrorMacro. More...

virtual void	SuppressErrorMessagesOn ()
	If on, then the Parse method will NOT report an error using vtkErrorMacro. More...

virtual void	SuppressErrorMessagesOff ()
	If on, then the Parse method will NOT report an error using vtkErrorMacro. More...

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

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 ()

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
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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 )

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

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

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)

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 )

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

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

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)

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)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

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

static vtkPVXMLParser *	SafeDownCast (vtkObject *o)

static vtkPVXMLParser *	New ()

static vtkSmartPointer< vtkPVXMLElement >	ParseXML (const char *xmlcontents, bool suppress_errors=false)
	Convenience method to parse XML contents. More...

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

static vtkXMLParser *	SafeDownCast (vtkObjectBase *o)

static vtkXMLParser *	New ()

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

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

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkPVXMLParser ()

	~vtkPVXMLParser () override

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

void	EndElement (const char *name) override

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

void	AddElement (vtkPVXMLElement *element)

void	PushOpenElement (vtkPVXMLElement *element)

vtkPVXMLElement *	PopOpenElement ()

int	ParseXML () override

void	ReportXmlParseError () override

Protected Member Functions inherited from vtkXMLParser
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkXMLParser ()

	~vtkXMLParser ()

virtual int	CreateParser ()

virtual int	ParsingComplete ()

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)

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 ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

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 &)

Protected Attributes
int	SuppressErrorMessages

vtkPVXMLElement *	RootElement

vtkPVXMLElement **	OpenElements

unsigned int	NumberOfOpenElements

unsigned int	OpenElementsSize

unsigned int	ElementIdIndex

Protected Attributes inherited from vtkXMLParser
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

Additional Inherited Members
Static Protected Member Functions inherited from vtkXMLParser
static int	IsSpace (char c)

Detailed Description

This is a subclass of vtkXMLParser that constructs a representation of parsed XML using vtkPVXMLElement.

Definition at line 19 of file vtkPVXMLParser.h.

Member Typedef Documentation

◆ Superclass

typedef vtkXMLParser vtkPVXMLParser::Superclass

Definition at line 22 of file vtkPVXMLParser.h.

Constructor & Destructor Documentation

◆ vtkPVXMLParser()

vtkPVXMLParser::vtkPVXMLParser ( )

protected

◆ ~vtkPVXMLParser()

vtkPVXMLParser::~vtkPVXMLParser ( )

overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPVXMLParser::GetClassName ( )

virtual

◆ IsTypeOf()

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

static

◆ IsA()

virtual int vtkPVXMLParser::IsA ( const char * type )

virtual

Reimplemented from vtkXMLParser.

◆ SafeDownCast()

static vtkPVXMLParser* vtkPVXMLParser::SafeDownCast ( vtkObject * o )

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkXMLParser.

◆ New()

static vtkPVXMLParser* vtkPVXMLParser::New ( )

static

◆ PrintXML()

void vtkPVXMLParser::PrintXML ( ostream & os )

Write the parsed XML into the output stream.

◆ GetRootElement()

vtkPVXMLElement* vtkPVXMLParser::GetRootElement ( )

Get the root element from the XML document.

◆ GetSuppressErrorMessages()

virtual int vtkPVXMLParser::GetSuppressErrorMessages ( )

virtual

If on, then the Parse method will NOT report an error using vtkErrorMacro.

Rather, it will just return false. This feature is useful when simply checking to see if a file is a valid XML file or there is otherwise a way to recover from the failed parse. This flag is off by default.

◆ SetSuppressErrorMessages()

virtual void vtkPVXMLParser::SetSuppressErrorMessages ( int )

virtual

If on, then the Parse method will NOT report an error using vtkErrorMacro.

Rather, it will just return false. This feature is useful when simply checking to see if a file is a valid XML file or there is otherwise a way to recover from the failed parse. This flag is off by default.

◆ SuppressErrorMessagesOn()

virtual void vtkPVXMLParser::SuppressErrorMessagesOn ( )

virtual

If on, then the Parse method will NOT report an error using vtkErrorMacro.

Rather, it will just return false. This feature is useful when simply checking to see if a file is a valid XML file or there is otherwise a way to recover from the failed parse. This flag is off by default.

◆ SuppressErrorMessagesOff()

virtual void vtkPVXMLParser::SuppressErrorMessagesOff ( )

virtual

If on, then the Parse method will NOT report an error using vtkErrorMacro.

Rather, it will just return false. This feature is useful when simply checking to see if a file is a valid XML file or there is otherwise a way to recover from the failed parse. This flag is off by default.

◆ ParseXML() [1/2]

static vtkSmartPointer<vtkPVXMLElement> vtkPVXMLParser::ParseXML	(	const char *	xmlcontents,
		bool	suppress_errors = `false`
	)

static

Convenience method to parse XML contents.

Will return nullptr is the xmlcontents cannot be parsed.

◆ StartElement()

void vtkPVXMLParser::StartElement	(	const char *	name,
		const char **	atts
	)

overrideprotectedvirtual

Reimplemented from vtkXMLParser.

◆ EndElement()

void vtkPVXMLParser::EndElement ( const char * name )

overrideprotectedvirtual

Reimplemented from vtkXMLParser.

◆ CharacterDataHandler()

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

overrideprotectedvirtual

Reimplemented from vtkXMLParser.

◆ AddElement()

void vtkPVXMLParser::AddElement ( vtkPVXMLElement * element )

protected

◆ PushOpenElement()

void vtkPVXMLParser::PushOpenElement ( vtkPVXMLElement * element )

protected

◆ PopOpenElement()

vtkPVXMLElement* vtkPVXMLParser::PopOpenElement ( )

protected

◆ ParseXML() [2/2]

int vtkPVXMLParser::ParseXML ( )

overrideprotectedvirtual

Reimplemented from vtkXMLParser.

◆ ReportXmlParseError()

void vtkPVXMLParser::ReportXmlParseError ( )

overrideprotectedvirtual

Reimplemented from vtkXMLParser.

Member Data Documentation

◆ SuppressErrorMessages

int vtkPVXMLParser::SuppressErrorMessages

protected

Definition at line 59 of file vtkPVXMLParser.h.

◆ RootElement

vtkPVXMLElement* vtkPVXMLParser::RootElement

protected

Definition at line 70 of file vtkPVXMLParser.h.

◆ OpenElements

vtkPVXMLElement** vtkPVXMLParser::OpenElements

protected

Definition at line 73 of file vtkPVXMLParser.h.

◆ NumberOfOpenElements

unsigned int vtkPVXMLParser::NumberOfOpenElements

protected

Definition at line 74 of file vtkPVXMLParser.h.

◆ OpenElementsSize

unsigned int vtkPVXMLParser::OpenElementsSize

protected

Definition at line 75 of file vtkPVXMLParser.h.

◆ ElementIdIndex

unsigned int vtkPVXMLParser::ElementIdIndex

protected

Definition at line 78 of file vtkPVXMLParser.h.

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

/builds/gitlab-kitware-sciviz-ci/VTKExtensions/Core/vtkPVXMLParser.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPVXMLParser()

◆ ~vtkPVXMLParser()

Member Function Documentation

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ New()

◆ PrintXML()

◆ GetRootElement()

◆ GetSuppressErrorMessages()

◆ SetSuppressErrorMessages()

◆ SuppressErrorMessagesOn()

◆ SuppressErrorMessagesOff()

◆ ParseXML() [1/2]

◆ StartElement()

◆ EndElement()

◆ CharacterDataHandler()

◆ AddElement()

◆ PushOpenElement()

◆ PopOpenElement()

◆ ParseXML() [2/2]

◆ ReportXmlParseError()

Member Data Documentation

◆ SuppressErrorMessages

◆ RootElement

◆ OpenElements

◆ NumberOfOpenElements

◆ OpenElementsSize

◆ ElementIdIndex