ActiViz .NET  5.8.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Private Member Functions
Kitware.VTK.vtkXMLDataParser Class Reference

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

Inheritance diagram for Kitware.VTK.vtkXMLDataParser:
[legend]
Collaboration diagram for Kitware.VTK.vtkXMLDataParser:
[legend]

List of all members.

Public Types

enum  BigEndian_WrapperEnum { BigEndian = 0, LittleEndian = 1 }
 Get the root element from the XML document. More...

Public Member Functions

 vtkXMLDataParser (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkXMLDataParser ()
 *Undocumented Block
virtual void CharacterDataHandler (string data, int length)
 

virtual int GetAbort ()
 Get/Set flag to abort reading of data. This may be set by a progress event observer.
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). 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 int GetAttributesEncodingMaxValue ()
 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 int GetAttributesEncodingMinValue ()
 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 vtkDataCompressor GetCompressor ()
 Get/Set the compressor used to decompress binary and appended data after reading from the file.
virtual float GetProgress ()
 Get/Set progress of reading data. This may be checked by a progress event observer.
vtkXMLDataElement GetRootElement ()
 Get the root element from the XML document.
uint GetWordTypeSize (int wordType)
 Get the size of a word of the given type.
override int IsA (string type)
 *Undocumented Block
new vtkXMLDataParser NewInstance ()
 *Undocumented Block
override int Parse ()
 Parse the XML input and check that the file is safe to read. Returns 1 for okay, 0 for error.
int ReadAppendedData (int offset, IntPtr buffer, int startWord, int numWords, int wordType)
 Get the root element from the XML document.
int ReadAppendedData (int offset, string buffer, int startWord, int numWords)
 Get the root element from the XML document.
int ReadAsciiData (IntPtr buffer, int startWord, int numWords, int wordType)
 Get the root element from the XML document.
int ReadBinaryData (IntPtr buffer, int startWord, int maxWords, int wordType)
 Get the root element from the XML document.
int ReadInlineData (vtkXMLDataElement element, int isAscii, IntPtr buffer, int startWord, int numWords, int wordType)
 Get the root element from the XML document.
int ReadInlineData (vtkXMLDataElement element, int isAscii, string buffer, int startWord, int numWords)
 Get the root element from the XML document.
virtual void SetAbort (int _arg)
 Get/Set flag to abort reading of data. This may be set by a progress event observer.
virtual void SetAttributesEncoding (int _arg)
 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 void SetCompressor (vtkDataCompressor arg0)
 Get/Set the compressor used to decompress binary and appended data after reading from the file.
virtual void SetProgress (float _arg)
 Get/Set progress of reading data. This may be checked by a progress event observer.
- Public Member Functions inherited from Kitware.VTK.vtkXMLParser
 vtkXMLParser (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkXMLParser ()
 *Undocumented Block
virtual int CleanupParser ()
 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 string GetEncoding ()
 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 string GetFileName ()
 Set and get file name.
virtual int GetIgnoreCharacterData ()
 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 InitializeParser ()
 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 Parse (string inputString)
 Parse the XML message. If length is specified, parse only the first "length" characters.
virtual int Parse (string inputString, uint length)
 Parse the XML message. If length is specified, parse only the first "length" characters.
virtual int ParseChunk (string inputString, uint length)
 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.
void SeekG (int 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 void SetEncoding (string _arg)
 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 void SetFileName (string _arg)
 Set and get file name.
virtual void SetIgnoreCharacterData (int _arg)
 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.
int 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.
- Public Member Functions inherited from Kitware.VTK.vtkObject
 vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void DebugOff ()
 Turn debugging output off.
virtual void DebugOn ()
 Turn debugging output on.
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
byte GetDebug ()
 Get the value of the debug flag.
virtual uint GetMTime ()
 Return this object's modified time.
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void Modified ()
 Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on.
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string.
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events.
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
- Public Member Functions inherited from Kitware.VTK.vtkObjectBase
 vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void Register (vtkObjectBase o)
 Increase the reference count (mark as used by another object).
virtual void FastDelete ()
 Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string GetClassName ()
 Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions

static new vtkXMLDataParser New ()
 *Undocumented Block
static new int IsTypeOf (string type)
 *Undocumented Block
static new vtkXMLDataParser SafeDownCast (vtkObjectBase o)
 *Undocumented Block

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkXMLDataParser"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkXMLParser
- Public Attributes inherited from Kitware.VTK.vtkObject
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

static new readonly string MRClassNameKey = "16vtkXMLDataParser"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkXMLParser
- Static Public Attributes inherited from Kitware.VTK.vtkObject
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Static Private Member Functions

static vtkXMLDataParser ()
 Automatically generated type registration mechanics.

Detailed Description

vtkXMLDataParser - Used by vtkXMLReader to parse VTK XML files.

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


Member Enumeration Documentation

Get the root element from the XML document.

Enumerator:
BigEndian 

enum member

LittleEndian 

enum member


Constructor & Destructor Documentation

static Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser ( )
staticprivate

Automatically generated type registration mechanics.

Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser ( )

*Undocumented Block


Member Function Documentation

virtual void Kitware.VTK.vtkXMLDataParser.CharacterDataHandler ( string  data,
int  length 
)
virtual


override void Kitware.VTK.vtkXMLDataParser.Dispose ( bool  disposing)
protected

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkXMLParser.

virtual int Kitware.VTK.vtkXMLDataParser.GetAbort ( )
virtual

Get/Set flag to abort reading of data. This may be set by a progress event observer.

virtual int Kitware.VTK.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).

virtual int Kitware.VTK.vtkXMLDataParser.GetAttributesEncodingMaxValue ( )
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 int Kitware.VTK.vtkXMLDataParser.GetAttributesEncodingMinValue ( )
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 vtkDataCompressor Kitware.VTK.vtkXMLDataParser.GetCompressor ( )
virtual

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

Here is the call graph for this function:

virtual float Kitware.VTK.vtkXMLDataParser.GetProgress ( )
virtual

Get/Set progress of reading data. This may be checked by a progress event observer.

vtkXMLDataElement Kitware.VTK.vtkXMLDataParser.GetRootElement ( )

Get the root element from the XML document.

Here is the call graph for this function:

uint Kitware.VTK.vtkXMLDataParser.GetWordTypeSize ( int  wordType)

Get the size of a word of the given type.

override int Kitware.VTK.vtkXMLDataParser.IsA ( string  type)
virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkXMLParser.

static new int Kitware.VTK.vtkXMLDataParser.IsTypeOf ( string  type)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkXMLParser.

static new vtkXMLDataParser Kitware.VTK.vtkXMLDataParser.New ( )
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkXMLParser.

new vtkXMLDataParser Kitware.VTK.vtkXMLDataParser.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkXMLParser.

override int Kitware.VTK.vtkXMLDataParser.Parse ( )
virtual

Parse the XML input and check that the file is safe to read. Returns 1 for okay, 0 for error.

Reimplemented from Kitware.VTK.vtkXMLParser.

int Kitware.VTK.vtkXMLDataParser.ReadAppendedData ( int  offset,
IntPtr  buffer,
int  startWord,
int  numWords,
int  wordType 
)

Get the root element from the XML document.

int Kitware.VTK.vtkXMLDataParser.ReadAppendedData ( int  offset,
string  buffer,
int  startWord,
int  numWords 
)

Get the root element from the XML document.

int Kitware.VTK.vtkXMLDataParser.ReadAsciiData ( IntPtr  buffer,
int  startWord,
int  numWords,
int  wordType 
)

Get the root element from the XML document.

int Kitware.VTK.vtkXMLDataParser.ReadBinaryData ( IntPtr  buffer,
int  startWord,
int  maxWords,
int  wordType 
)

Get the root element from the XML document.

int Kitware.VTK.vtkXMLDataParser.ReadInlineData ( vtkXMLDataElement  element,
int  isAscii,
IntPtr  buffer,
int  startWord,
int  numWords,
int  wordType 
)

Get the root element from the XML document.

int Kitware.VTK.vtkXMLDataParser.ReadInlineData ( vtkXMLDataElement  element,
int  isAscii,
string  buffer,
int  startWord,
int  numWords 
)

Get the root element from the XML document.

static new vtkXMLDataParser Kitware.VTK.vtkXMLDataParser.SafeDownCast ( vtkObjectBase  o)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkXMLParser.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkXMLDataParser.SetAbort ( int  _arg)
virtual

Get/Set flag to abort reading of data. This may be set by a progress event observer.

virtual void Kitware.VTK.vtkXMLDataParser.SetAttributesEncoding ( int  _arg)
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 void Kitware.VTK.vtkXMLDataParser.SetCompressor ( vtkDataCompressor  arg0)
virtual

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

virtual void Kitware.VTK.vtkXMLDataParser.SetProgress ( float  _arg)
virtual

Get/Set progress of reading data. This may be checked by a progress event observer.


Member Data Documentation

new readonly string Kitware.VTK.vtkXMLDataParser.MRClassNameKey = "16vtkXMLDataParser"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkXMLParser.

new const string Kitware.VTK.vtkXMLDataParser.MRFullTypeName = "Kitware.VTK.vtkXMLDataParser"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkXMLParser.


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