VTK
9.1.0
|
Used by vtkXMLReader to parse VTK XML files. More...
#include <vtkXMLDataParser.h>
Public Types | |
enum | { BigEndian , LittleEndian } |
Enumerate big and little endian byte order settings. More... | |
typedef vtkXMLParser | Superclass |
![]() | |
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. More... | |
vtkXMLDataParser * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
vtkXMLDataElement * | GetRootElement () |
Get the root element from the XML document. More... | |
size_t | ReadInlineData (vtkXMLDataElement *element, int isAscii, void *buffer, vtkTypeUInt64 startWord, size_t numWords, int wordType) |
Read inline data from inside the given element. More... | |
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. More... | |
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. More... | |
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. More... | |
size_t | GetWordTypeSize (int wordType) |
Get the size of a word of the given type. More... | |
int | Parse () override |
Parse the XML input and check that the file is safe to read. More... | |
void | CharacterDataHandler (const char *data, int length) override |
If you need the text inside XMLElements, turn IgnoreCharacterData off. More... | |
vtkTypeInt64 | GetAppendedDataPosition () |
Returns the byte index of where appended data starts (if the file is using appended data). More... | |
virtual void | SetCompressor (vtkDataCompressor *) |
Get/Set the compressor used to decompress binary and appended data after reading from the file. More... | |
virtual vtkDataCompressor * | GetCompressor () |
Get/Set the compressor used to decompress binary and appended data after reading from the file. More... | |
virtual int | GetAbort () |
Get/Set flag to abort reading of data. More... | |
virtual void | SetAbort (int) |
Get/Set flag to abort reading of data. More... | |
virtual float | GetProgress () |
Get/Set progress of reading data. More... | |
virtual void | SetProgress (float) |
Get/Set progress of reading data. More... | |
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). More... | |
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). More... | |
![]() | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkXMLParser * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual int | Parse () |
Parse the XML input. More... | |
virtual void | SetStream (istream *) |
Get/Set the input stream. More... | |
virtual istream * | GetStream () |
Get/Set the input stream. More... | |
vtkTypeInt64 | TellG () |
Used by subclasses and their supporting classes. More... | |
void | SeekG (vtkTypeInt64 position) |
Used by subclasses and their supporting classes. More... | |
virtual int | InitializeParser () |
When parsing fragments of XML, or when streaming XML, use the following three methods: More... | |
virtual int | ParseChunk (const char *inputString, unsigned int length) |
When parsing fragments of XML, or when streaming XML, use the following three methods: More... | |
virtual int | CleanupParser () |
When parsing fragments of XML, or when streaming XML, use the following three methods: More... | |
vtkSetFilePathMacro (FileName) | |
Set and get file name. More... | |
vtkGetFilePathMacro (FileName) | |
Set and get file name. More... | |
virtual void | SetIgnoreCharacterData (int) |
If this is off (the default), CharacterDataHandler will be called to process text within XML Elements. More... | |
virtual int | GetIgnoreCharacterData () |
If this is off (the default), CharacterDataHandler will be called to process text within XML Elements. More... | |
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). More... | |
virtual char * | GetEncoding () |
Set and get the encoding the parser should expect (nullptr defaults to Expat's own default encoder, i.e UTF-8). More... | |
![]() | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. More... | |
virtual void | DebugOff () |
Turn debugging output off. More... | |
bool | GetDebug () |
Get the value of the debug flag. More... | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. More... | |
virtual void | Modified () |
Update the modification time for this object. More... | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. More... | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
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) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
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. More... | |
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. More... | |
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. More... | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. More... | |
int | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. More... | |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. More... | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
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). More... | |
virtual void | Delete () |
Delete a VTK object. More... | |
virtual void | FastDelete () |
Delete a reference to this object. More... | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. More... | |
virtual void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). More... | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). More... | |
int | GetReferenceCount () |
Return the current reference count of this object. More... | |
void | SetReferenceCount (int) |
Sets the reference count. More... | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. More... | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkXMLDataParser * | SafeDownCast (vtkObjectBase *o) |
static vtkXMLDataParser * | New () |
![]() | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkXMLParser * | SafeDownCast (vtkObjectBase *o) |
static vtkXMLParser * | New () |
![]() | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. More... | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static int | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
![]() | |
static vtkTypeBool | IsTypeOf (const char *name) |
Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
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). More... | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More... | |
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. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkXMLDataParser () | |
~vtkXMLDataParser () override | |
int | Parse (const char *) override |
Parse the XML message. More... | |
int | Parse (const char *, unsigned int) override |
Parse the XML message. More... | |
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) |
vtkXMLDataElement * | PopOpenElement () |
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) |
![]() | |
virtual vtkObjectBase * | NewInstanceInternal () 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) |
![]() | |
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. More... | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. More... | |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Additional Inherited Members | |
![]() | |
static int | IsSpace (char c) |
![]() | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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.
Definition at line 39 of file vtkXMLDataParser.h.
Definition at line 42 of file vtkXMLDataParser.h.
anonymous enum |
Enumerate big and little endian byte order settings.
Enumerator | |
---|---|
BigEndian | |
LittleEndian |
Definition at line 54 of file vtkXMLDataParser.h.
|
protected |
|
overrideprotected |
|
static |
|
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.
|
static |
|
protectedvirtual |
Reimplemented from vtkXMLParser.
vtkXMLDataParser * vtkXMLDataParser::NewInstance | ( | ) | const |
|
overridevirtual |
|
static |
vtkXMLDataElement * vtkXMLDataParser::GetRootElement | ( | ) |
Get the root element from the XML document.
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.
|
inline |
Definition at line 66 of file vtkXMLDataParser.h.
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.
|
inline |
Definition at line 78 of file vtkXMLDataParser.h.
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.
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.
|
virtual |
Get/Set the compressor used to decompress binary and appended data after reading from the file.
|
virtual |
Get/Set the compressor used to decompress binary and appended data after reading from the file.
size_t vtkXMLDataParser::GetWordTypeSize | ( | int | wordType | ) |
Get the size of a word of the given type.
|
overridevirtual |
Parse the XML input and check that the file is safe to read.
Returns 1 for okay, 0 for error.
Reimplemented from vtkXMLParser.
|
virtual |
Get/Set flag to abort reading of data.
This may be set by a progress event observer.
|
virtual |
Get/Set flag to abort reading of data.
This may be set by a progress event observer.
|
virtual |
Get/Set progress of reading data.
This may be checked by a progress event observer.
|
virtual |
Get/Set progress of reading data.
This may be checked by a progress event observer.
|
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).
|
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).
|
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 263 of file vtkXMLDataParser.h.
|
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 159 of file vtkXMLDataParser.h.
|
overrideprotectedvirtual |
Parse the XML message.
If length is specified, parse only the first "length" characters
Reimplemented from vtkXMLParser.
|
overrideprotectedvirtual |
Parse the XML message.
If length is specified, parse only the first "length" characters
Reimplemented from vtkXMLParser.
|
overrideprotectedvirtual |
Reimplemented from vtkXMLParser.
|
overrideprotectedvirtual |
Reimplemented from vtkXMLParser.
|
overrideprotectedvirtual |
Reimplemented from vtkXMLParser.
|
protected |
|
protected |
|
overrideprotectedvirtual |
Reimplemented from vtkXMLParser.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Definition at line 205 of file vtkXMLDataParser.h.
|
protected |
Definition at line 208 of file vtkXMLDataParser.h.
|
protected |
Definition at line 209 of file vtkXMLDataParser.h.
|
protected |
Definition at line 210 of file vtkXMLDataParser.h.
|
protected |
Definition at line 213 of file vtkXMLDataParser.h.
|
protected |
Definition at line 216 of file vtkXMLDataParser.h.
|
protected |
Definition at line 219 of file vtkXMLDataParser.h.
|
protected |
Definition at line 222 of file vtkXMLDataParser.h.
|
protected |
Definition at line 226 of file vtkXMLDataParser.h.
|
protected |
Definition at line 230 of file vtkXMLDataParser.h.
|
protected |
Definition at line 233 of file vtkXMLDataParser.h.
|
protected |
Definition at line 236 of file vtkXMLDataParser.h.
|
protected |
Definition at line 237 of file vtkXMLDataParser.h.
|
protected |
Definition at line 238 of file vtkXMLDataParser.h.
|
protected |
Definition at line 239 of file vtkXMLDataParser.h.
|
protected |
Definition at line 240 of file vtkXMLDataParser.h.
|
protected |
Definition at line 241 of file vtkXMLDataParser.h.
|
protected |
Definition at line 244 of file vtkXMLDataParser.h.
|
protected |
Definition at line 245 of file vtkXMLDataParser.h.
|
protected |
Definition at line 246 of file vtkXMLDataParser.h.
|
protected |
Definition at line 247 of file vtkXMLDataParser.h.
|
protected |
Definition at line 250 of file vtkXMLDataParser.h.
|
protected |
Definition at line 253 of file vtkXMLDataParser.h.
|
protected |
Definition at line 255 of file vtkXMLDataParser.h.