ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPVXMLParser Class Reference

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

#include <vtkPVXMLParser.h>

Inherits vtkXMLParser.

Collaboration diagram for vtkPVXMLParser:
Collaboration graph
[legend]

Public Types

typedef vtkXMLParser Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void PrintXML (ostream &os)
 Write the parsed XML into the output stream. More...
 
vtkPVXMLElementGetRootElement ()
 Get the root element from the XML document. More...
 
virtual void SetFileName (const char *)
 Get/Set the file from which to read the configuration. More...
 
virtual char * GetFileName ()
 Get/Set the file from which to read the configuration. 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...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPVXMLParserSafeDownCast (vtkObject *o)
 
static vtkPVXMLParserNew ()
 
static vtkSmartPointer< vtkPVXMLElementParseXML (const char *xmlcontents, bool suppress_errors=false)
 Convenience method to parse XML contents. More...
 

Protected Member Functions

 vtkPVXMLParser ()
 
 ~vtkPVXMLParser ()
 
void StartElement (const char *name, const char **atts)
 
void EndElement (const char *name)
 
void CharacterDataHandler (const char *data, int length)
 
void AddElement (vtkPVXMLElement *element)
 
void PushOpenElement (vtkPVXMLElement *element)
 
vtkPVXMLElementPopOpenElement ()
 
virtual int ParseXML ()
 
virtual void ReportXmlParseError ()
 

Protected Attributes

int SuppressErrorMessages
 
vtkPVXMLElementRootElement
 
vtkPVXMLElement ** OpenElements
 
unsigned int NumberOfOpenElements
 
unsigned int OpenElementsSize
 
unsigned int ElementIdIndex
 

Detailed Description

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

Definition at line 31 of file vtkPVXMLParser.h.

Member Typedef Documentation

◆ Superclass

typedef vtkXMLParser vtkPVXMLParser::Superclass

Definition at line 34 of file vtkPVXMLParser.h.

Constructor & Destructor Documentation

◆ vtkPVXMLParser()

vtkPVXMLParser::vtkPVXMLParser ( )
protected

◆ ~vtkPVXMLParser()

vtkPVXMLParser::~vtkPVXMLParser ( )
protected

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ 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.

◆ SetFileName()

virtual void vtkPVXMLParser::SetFileName ( const char *  )
virtual

Get/Set the file from which to read the configuration.

◆ GetFileName()

virtual char* vtkPVXMLParser::GetFileName ( )
virtual

Get/Set the file from which to read the configuration.

◆ 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 NULL is the xmlcontents cannot be parsed.

◆ StartElement()

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

◆ EndElement()

void vtkPVXMLParser::EndElement ( const char *  name)
protected

◆ CharacterDataHandler()

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

◆ AddElement()

void vtkPVXMLParser::AddElement ( vtkPVXMLElement element)
protected

◆ PushOpenElement()

void vtkPVXMLParser::PushOpenElement ( vtkPVXMLElement element)
protected

◆ PopOpenElement()

vtkPVXMLElement* vtkPVXMLParser::PopOpenElement ( )
protected

◆ ParseXML() [2/2]

virtual int vtkPVXMLParser::ParseXML ( )
protectedvirtual

◆ ReportXmlParseError()

virtual void vtkPVXMLParser::ReportXmlParseError ( )
protectedvirtual

Member Data Documentation

◆ SuppressErrorMessages

int vtkPVXMLParser::SuppressErrorMessages
protected

Definition at line 79 of file vtkPVXMLParser.h.

◆ RootElement

vtkPVXMLElement* vtkPVXMLParser::RootElement
protected

Definition at line 90 of file vtkPVXMLParser.h.

◆ OpenElements

vtkPVXMLElement** vtkPVXMLParser::OpenElements
protected

Definition at line 93 of file vtkPVXMLParser.h.

◆ NumberOfOpenElements

unsigned int vtkPVXMLParser::NumberOfOpenElements
protected

Definition at line 94 of file vtkPVXMLParser.h.

◆ OpenElementsSize

unsigned int vtkPVXMLParser::OpenElementsSize
protected

Definition at line 95 of file vtkPVXMLParser.h.

◆ ElementIdIndex

unsigned int vtkPVXMLParser::ElementIdIndex
protected

Definition at line 98 of file vtkPVXMLParser.h.


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