VTK  9.4.20241220
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkXMLDataParser Class Reference

Used by vtkXMLReader to parse VTK XML files. More...

#include <vtkXMLDataParser.h>

Inheritance diagram for vtkXMLDataParser:
[legend]
Collaboration diagram for vtkXMLDataParser:
[legend]

Public Types

enum  { BigEndian , LittleEndian }
 Enumerate big and little endian byte order settings. More...
 
typedef vtkXMLParser Superclass
 
- Public Types inherited from vtkXMLParser
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkXMLDataParserNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkXMLDataElementGetRootElement ()
 Get the root element from the XML document.
 
size_t ReadInlineData (vtkXMLDataElement *element, int isAscii, void *buffer, vtkTypeUInt64 startWord, size_t numWords, int wordType)
 Read inline data from inside the given element.
 
size_t ReadInlineData (vtkXMLDataElement *element, int isAscii, char *buffer, vtkTypeUInt64 startWord, size_t numWords)
 
size_t ReadAppendedData (vtkTypeInt64 offset, void *buffer, vtkTypeUInt64 startWord, size_t numWords, int wordType)
 Read from an appended data section starting at the given appended data offset.
 
size_t ReadAppendedData (vtkTypeInt64 offset, char *buffer, vtkTypeUInt64 startWord, size_t numWords)
 
size_t ReadAsciiData (void *buffer, vtkTypeUInt64 startWord, size_t numWords, int wordType)
 Read from an ascii data section starting at the current position in the stream.
 
size_t ReadBinaryData (void *buffer, vtkTypeUInt64 startWord, size_t maxWords, int wordType)
 Read from a data section starting at the current position in the stream.
 
size_t GetWordTypeSize (int wordType)
 Get the size of a word of the given type.
 
int Parse () override
 Parse the XML input and check that the file is safe to read.
 
void CharacterDataHandler (const char *data, int length) override
 If you need the text inside XMLElements, turn IgnoreCharacterData off.
 
vtkTypeInt64 GetAppendedDataPosition ()
 Returns the byte index of where appended data starts (if the file is using appended data).
 
virtual void SetCompressor (vtkDataCompressor *)
 Get/Set the compressor used to decompress binary and appended data after reading from the file.
 
virtual vtkDataCompressorGetCompressor ()
 Get/Set the compressor used to decompress binary and appended data after reading from the file.
 
virtual int GetAbort ()
 Get/Set flag to abort reading of data.
 
virtual void SetAbort (int)
 Get/Set flag to abort reading of data.
 
virtual float GetProgress ()
 Get/Set progress of reading data.
 
virtual void SetProgress (float)
 Get/Set progress of reading data.
 
virtual void SetAttributesEncoding (int)
 Get/Set the character encoding that will be used to set the attributes's encoding type of each vtkXMLDataElement created by this parser (i.e., the data element attributes will use that encoding internally).
 
virtual int GetAttributesEncoding ()
 Get/Set the character encoding that will be used to set the attributes's encoding type of each vtkXMLDataElement created by this parser (i.e., the data element attributes will use that encoding internally).
 
- Public Member Functions inherited from vtkXMLParser
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkXMLParserNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual int Parse ()
 Parse the XML input.
 
virtual void SetStream (istream *)
 Get/Set the input stream.
 
virtual istream * GetStream ()
 Get/Set the input stream.
 
vtkTypeInt64 TellG ()
 Used by subclasses and their supporting classes.
 
void SeekG (vtkTypeInt64 position)
 Used by subclasses and their supporting classes.
 
virtual int InitializeParser ()
 When parsing fragments of XML, or when streaming XML, use the following three methods:
 
virtual int ParseChunk (const char *inputString, unsigned int length)
 When parsing fragments of XML, or when streaming XML, use the following three methods:
 
virtual int CleanupParser ()
 When parsing fragments of XML, or when streaming XML, use the following three methods:
 
 vtkSetFilePathMacro (FileName)
 Set and get file name.
 
 vtkGetFilePathMacro (FileName)
 Set and get file name.
 
virtual void SetIgnoreCharacterData (vtkTypeBool)
 If this is off (the default), CharacterDataHandler will be called to process text within XML Elements.
 
virtual vtkTypeBool GetIgnoreCharacterData ()
 If this is off (the default), CharacterDataHandler will be called to process text within XML Elements.
 
virtual void SetEncoding (const char *)
 Set and get the encoding the parser should expect (nullptr defaults to Expat's own default encoder, i.e UTF-8).
 
virtual char * GetEncoding ()
 Set and get the encoding the parser should expect (nullptr defaults to Expat's own default encoder, i.e UTF-8).
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLDataParserSafeDownCast (vtkObjectBase *o)
 
static vtkXMLDataParserNew ()
 
- Static Public Member Functions inherited from vtkXMLParser
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLParserSafeDownCast (vtkObjectBase *o)
 
static vtkXMLParserNew ()
 
static bool hasLargeOffsets ()
 The Expat library can only handle binary files > 2Gb if either size_of(long) == 8 or the "large size" feature is present.
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkXMLDataParser ()
 
 ~vtkXMLDataParser () override
 
int Parse (const char *) override
 Parse the XML message.
 
int Parse (const char *, unsigned int) override
 Parse the XML message.
 
void StartElement (const char *name, const char **atts) override
 
void EndElement (const char *) override
 
int ParsingComplete () override
 
int CheckPrimaryAttributes ()
 
void FindAppendedDataPosition ()
 
int ParseBuffer (const char *buffer, unsigned int count) override
 
void AddElement (vtkXMLDataElement *element)
 
void PushOpenElement (vtkXMLDataElement *element)
 
vtkXMLDataElementPopOpenElement ()
 
void FreeAllElements ()
 
void PerformByteSwap (void *data, size_t numWords, size_t wordSize)
 
int ReadCompressionHeader ()
 
size_t FindBlockSize (vtkTypeUInt64 block)
 
int ReadBlock (vtkTypeUInt64 block, unsigned char *buffer)
 
unsigned char * ReadBlock (vtkTypeUInt64 block)
 
size_t ReadUncompressedData (unsigned char *data, vtkTypeUInt64 startWord, size_t numWords, size_t wordSize)
 
size_t ReadCompressedData (unsigned char *data, vtkTypeUInt64 startWord, size_t numWords, size_t wordSize)
 
void SeekInlineDataPosition (vtkXMLDataElement *element)
 
int ParseAsciiData (int wordType)
 
void FreeAsciiBuffer ()
 
void UpdateProgress (float progress)
 
- Protected Member Functions inherited from vtkXMLParser
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkXMLParser ()
 
 ~vtkXMLParser () override
 
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 ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkXMLDataElementRootElement
 
vtkXMLDataElement ** OpenElements
 
unsigned int NumberOfOpenElements
 
unsigned int OpenElementsSize
 
vtkTypeInt64 AppendedDataPosition
 
int AppendedDataMatched
 
bool AppendedDataFound
 
int ByteOrder
 
int HeaderType
 
vtkInputStreamDataStream
 
vtkInputStreamInlineDataStream
 
vtkInputStreamAppendedDataStream
 
vtkDataCompressorCompressor
 
size_t NumberOfBlocks
 
size_t BlockUncompressedSize
 
size_t PartialLastBlockUncompressedSize
 
size_t * BlockCompressedSizes
 
vtkTypeInt64 * BlockStartOffsets
 
unsigned char * AsciiDataBuffer
 
size_t AsciiDataBufferLength
 
int AsciiDataWordType
 
vtkTypeInt64 AsciiDataPosition
 
float Progress
 
int Abort
 
int AttributesEncoding
 
- Protected Attributes inherited from vtkXMLParser
istream * Stream
 
char * FileName
 
char * Encoding
 
int ParseError
 
const char * InputString
 
int InputStringLength
 
void * Parser
 
vtkTypeBool IgnoreCharacterData
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkXMLParser
static int IsSpace (char c)
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

Used by vtkXMLReader to parse VTK XML files.

vtkXMLDataParser provides a subclass of vtkXMLParser that constructs a representation of an XML data format's file using vtkXMLDataElement to represent each XML element. This representation is then used by vtkXMLReader and its subclasses to traverse the structure of the file and extract data.

See also
vtkXMLDataElement
Events:
vtkCommand::ProgressEvent

Definition at line 31 of file vtkXMLDataParser.h.

Member Typedef Documentation

◆ Superclass

Definition at line 34 of file vtkXMLDataParser.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerate big and little endian byte order settings.

Enumerator
BigEndian 
LittleEndian 

Definition at line 46 of file vtkXMLDataParser.h.

Constructor & Destructor Documentation

◆ vtkXMLDataParser()

vtkXMLDataParser::vtkXMLDataParser ( )
protected

◆ ~vtkXMLDataParser()

vtkXMLDataParser::~vtkXMLDataParser ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkXMLDataParser::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkXMLDataParser::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 vtkXMLParser.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkXMLDataParser::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkXMLParser.

◆ NewInstance()

vtkXMLDataParser * vtkXMLDataParser::NewInstance ( ) const

◆ PrintSelf()

void vtkXMLDataParser::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ New()

static vtkXMLDataParser * vtkXMLDataParser::New ( )
static

◆ GetRootElement()

vtkXMLDataElement * vtkXMLDataParser::GetRootElement ( )

Get the root element from the XML document.

◆ ReadInlineData() [1/2]

size_t vtkXMLDataParser::ReadInlineData ( vtkXMLDataElement element,
int  isAscii,
void *  buffer,
vtkTypeUInt64  startWord,
size_t  numWords,
int  wordType 
)

Read inline data from inside the given element.

Returns the number of words read.

◆ ReadInlineData() [2/2]

size_t vtkXMLDataParser::ReadInlineData ( vtkXMLDataElement element,
int  isAscii,
char *  buffer,
vtkTypeUInt64  startWord,
size_t  numWords 
)
inline

Definition at line 58 of file vtkXMLDataParser.h.

◆ ReadAppendedData() [1/2]

size_t vtkXMLDataParser::ReadAppendedData ( vtkTypeInt64  offset,
void *  buffer,
vtkTypeUInt64  startWord,
size_t  numWords,
int  wordType 
)

Read from an appended data section starting at the given appended data offset.

Returns the number of words read.

◆ ReadAppendedData() [2/2]

size_t vtkXMLDataParser::ReadAppendedData ( vtkTypeInt64  offset,
char *  buffer,
vtkTypeUInt64  startWord,
size_t  numWords 
)
inline

Definition at line 70 of file vtkXMLDataParser.h.

◆ ReadAsciiData()

size_t vtkXMLDataParser::ReadAsciiData ( void *  buffer,
vtkTypeUInt64  startWord,
size_t  numWords,
int  wordType 
)

Read from an ascii data section starting at the current position in the stream.

Returns the number of words read.

◆ ReadBinaryData()

size_t vtkXMLDataParser::ReadBinaryData ( void *  buffer,
vtkTypeUInt64  startWord,
size_t  maxWords,
int  wordType 
)

Read from a data section starting at the current position in the stream.

Returns the number of words read.

◆ SetCompressor()

virtual void vtkXMLDataParser::SetCompressor ( vtkDataCompressor )
virtual

Get/Set the compressor used to decompress binary and appended data after reading from the file.

◆ GetCompressor()

virtual vtkDataCompressor * vtkXMLDataParser::GetCompressor ( )
virtual

Get/Set the compressor used to decompress binary and appended data after reading from the file.

◆ GetWordTypeSize()

size_t vtkXMLDataParser::GetWordTypeSize ( int  wordType)

Get the size of a word of the given type.

◆ Parse() [1/3]

int vtkXMLDataParser::Parse ( )
overridevirtual

Parse the XML input and check that the file is safe to read.

Returns 1 for okay, 0 for error.

Reimplemented from vtkXMLParser.

◆ GetAbort()

virtual int vtkXMLDataParser::GetAbort ( )
virtual

Get/Set flag to abort reading of data.

This may be set by a progress event observer.

◆ SetAbort()

virtual void vtkXMLDataParser::SetAbort ( int  )
virtual

Get/Set flag to abort reading of data.

This may be set by a progress event observer.

◆ GetProgress()

virtual float vtkXMLDataParser::GetProgress ( )
virtual

Get/Set progress of reading data.

This may be checked by a progress event observer.

◆ SetProgress()

virtual void vtkXMLDataParser::SetProgress ( float  )
virtual

Get/Set progress of reading data.

This may be checked by a progress event observer.

◆ SetAttributesEncoding()

virtual void vtkXMLDataParser::SetAttributesEncoding ( int  )
virtual

Get/Set the character encoding that will be used to set the attributes's encoding type of each vtkXMLDataElement created by this parser (i.e., the data element attributes will use that encoding internally).

If set to VTK_ENCODING_NONE (default), the attribute encoding type will not be changed and will default to the vtkXMLDataElement default encoding type (see vtkXMLDataElement::AttributeEncoding).

◆ GetAttributesEncoding()

virtual int vtkXMLDataParser::GetAttributesEncoding ( )
virtual

Get/Set the character encoding that will be used to set the attributes's encoding type of each vtkXMLDataElement created by this parser (i.e., the data element attributes will use that encoding internally).

If set to VTK_ENCODING_NONE (default), the attribute encoding type will not be changed and will default to the vtkXMLDataElement default encoding type (see vtkXMLDataElement::AttributeEncoding).

◆ CharacterDataHandler()

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

If you need the text inside XMLElements, turn IgnoreCharacterData off.

This method will then be called when the file is parsed, and the text will be stored in each XMLDataElement. VTK XML Readers store the information elsewhere, so the default is to ignore it.

Reimplemented from vtkXMLParser.

Definition at line 258 of file vtkXMLDataParser.h.

◆ GetAppendedDataPosition()

vtkTypeInt64 vtkXMLDataParser::GetAppendedDataPosition ( )
inline

Returns the byte index of where appended data starts (if the file is using appended data).

Valid after the XML is parsed.

Definition at line 151 of file vtkXMLDataParser.h.

◆ Parse() [2/3]

int vtkXMLDataParser::Parse ( const char *  inputString)
overrideprotectedvirtual

Parse the XML message.

If length is specified, parse only the first "length" characters

Reimplemented from vtkXMLParser.

◆ Parse() [3/3]

int vtkXMLDataParser::Parse ( const char *  inputString,
unsigned int  length 
)
overrideprotectedvirtual

Parse the XML message.

If length is specified, parse only the first "length" characters

Reimplemented from vtkXMLParser.

◆ StartElement()

void vtkXMLDataParser::StartElement ( const char *  name,
const char **  atts 
)
overrideprotectedvirtual

Reimplemented from vtkXMLParser.

◆ EndElement()

void vtkXMLDataParser::EndElement ( const char *  )
overrideprotectedvirtual

Reimplemented from vtkXMLParser.

◆ ParsingComplete()

int vtkXMLDataParser::ParsingComplete ( )
overrideprotectedvirtual

Reimplemented from vtkXMLParser.

◆ CheckPrimaryAttributes()

int vtkXMLDataParser::CheckPrimaryAttributes ( )
protected

◆ FindAppendedDataPosition()

void vtkXMLDataParser::FindAppendedDataPosition ( )
protected

◆ ParseBuffer()

int vtkXMLDataParser::ParseBuffer ( const char *  buffer,
unsigned int  count 
)
overrideprotectedvirtual

Reimplemented from vtkXMLParser.

◆ AddElement()

void vtkXMLDataParser::AddElement ( vtkXMLDataElement element)
protected

◆ PushOpenElement()

void vtkXMLDataParser::PushOpenElement ( vtkXMLDataElement element)
protected

◆ PopOpenElement()

vtkXMLDataElement * vtkXMLDataParser::PopOpenElement ( )
protected

◆ FreeAllElements()

void vtkXMLDataParser::FreeAllElements ( )
protected

◆ PerformByteSwap()

void vtkXMLDataParser::PerformByteSwap ( void *  data,
size_t  numWords,
size_t  wordSize 
)
protected

◆ ReadCompressionHeader()

int vtkXMLDataParser::ReadCompressionHeader ( )
protected

◆ FindBlockSize()

size_t vtkXMLDataParser::FindBlockSize ( vtkTypeUInt64  block)
protected

◆ ReadBlock() [1/2]

int vtkXMLDataParser::ReadBlock ( vtkTypeUInt64  block,
unsigned char *  buffer 
)
protected

◆ ReadBlock() [2/2]

unsigned char * vtkXMLDataParser::ReadBlock ( vtkTypeUInt64  block)
protected

◆ ReadUncompressedData()

size_t vtkXMLDataParser::ReadUncompressedData ( unsigned char *  data,
vtkTypeUInt64  startWord,
size_t  numWords,
size_t  wordSize 
)
protected

◆ ReadCompressedData()

size_t vtkXMLDataParser::ReadCompressedData ( unsigned char *  data,
vtkTypeUInt64  startWord,
size_t  numWords,
size_t  wordSize 
)
protected

◆ SeekInlineDataPosition()

void vtkXMLDataParser::SeekInlineDataPosition ( vtkXMLDataElement element)
protected

◆ ParseAsciiData()

int vtkXMLDataParser::ParseAsciiData ( int  wordType)
protected

◆ FreeAsciiBuffer()

void vtkXMLDataParser::FreeAsciiBuffer ( )
protected

◆ UpdateProgress()

void vtkXMLDataParser::UpdateProgress ( float  progress)
protected

Member Data Documentation

◆ RootElement

vtkXMLDataElement* vtkXMLDataParser::RootElement
protected

Definition at line 197 of file vtkXMLDataParser.h.

◆ OpenElements

vtkXMLDataElement** vtkXMLDataParser::OpenElements
protected

Definition at line 200 of file vtkXMLDataParser.h.

◆ NumberOfOpenElements

unsigned int vtkXMLDataParser::NumberOfOpenElements
protected

Definition at line 201 of file vtkXMLDataParser.h.

◆ OpenElementsSize

unsigned int vtkXMLDataParser::OpenElementsSize
protected

Definition at line 202 of file vtkXMLDataParser.h.

◆ AppendedDataPosition

vtkTypeInt64 vtkXMLDataParser::AppendedDataPosition
protected

Definition at line 205 of file vtkXMLDataParser.h.

◆ AppendedDataMatched

int vtkXMLDataParser::AppendedDataMatched
protected

Definition at line 208 of file vtkXMLDataParser.h.

◆ AppendedDataFound

bool vtkXMLDataParser::AppendedDataFound
protected

Definition at line 211 of file vtkXMLDataParser.h.

◆ ByteOrder

int vtkXMLDataParser::ByteOrder
protected

Definition at line 214 of file vtkXMLDataParser.h.

◆ HeaderType

int vtkXMLDataParser::HeaderType
protected

Definition at line 217 of file vtkXMLDataParser.h.

◆ DataStream

vtkInputStream* vtkXMLDataParser::DataStream
protected

Definition at line 221 of file vtkXMLDataParser.h.

◆ InlineDataStream

vtkInputStream* vtkXMLDataParser::InlineDataStream
protected

Definition at line 225 of file vtkXMLDataParser.h.

◆ AppendedDataStream

vtkInputStream* vtkXMLDataParser::AppendedDataStream
protected

Definition at line 228 of file vtkXMLDataParser.h.

◆ Compressor

vtkDataCompressor* vtkXMLDataParser::Compressor
protected

Definition at line 231 of file vtkXMLDataParser.h.

◆ NumberOfBlocks

size_t vtkXMLDataParser::NumberOfBlocks
protected

Definition at line 232 of file vtkXMLDataParser.h.

◆ BlockUncompressedSize

size_t vtkXMLDataParser::BlockUncompressedSize
protected

Definition at line 233 of file vtkXMLDataParser.h.

◆ PartialLastBlockUncompressedSize

size_t vtkXMLDataParser::PartialLastBlockUncompressedSize
protected

Definition at line 234 of file vtkXMLDataParser.h.

◆ BlockCompressedSizes

size_t* vtkXMLDataParser::BlockCompressedSizes
protected

Definition at line 235 of file vtkXMLDataParser.h.

◆ BlockStartOffsets

vtkTypeInt64* vtkXMLDataParser::BlockStartOffsets
protected

Definition at line 236 of file vtkXMLDataParser.h.

◆ AsciiDataBuffer

unsigned char* vtkXMLDataParser::AsciiDataBuffer
protected

Definition at line 239 of file vtkXMLDataParser.h.

◆ AsciiDataBufferLength

size_t vtkXMLDataParser::AsciiDataBufferLength
protected

Definition at line 240 of file vtkXMLDataParser.h.

◆ AsciiDataWordType

int vtkXMLDataParser::AsciiDataWordType
protected

Definition at line 241 of file vtkXMLDataParser.h.

◆ AsciiDataPosition

vtkTypeInt64 vtkXMLDataParser::AsciiDataPosition
protected

Definition at line 242 of file vtkXMLDataParser.h.

◆ Progress

float vtkXMLDataParser::Progress
protected

Definition at line 245 of file vtkXMLDataParser.h.

◆ Abort

int vtkXMLDataParser::Abort
protected

Definition at line 248 of file vtkXMLDataParser.h.

◆ AttributesEncoding

int vtkXMLDataParser::AttributesEncoding
protected

Definition at line 250 of file vtkXMLDataParser.h.


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