ActiViz .NET  5.8.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private 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.

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.

Static Public Attributes

static new readonly string MRClassNameKey = "16vtkXMLDataParser"
 Automatically generated type registration mechanics.

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.

Private Member Functions

static internal IntPtr vtkXMLDataParser_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkXMLDataParser_CharacterDataHandler_01 (HandleRef pThis, string data, int length)
static internal int vtkXMLDataParser_GetAbort_02 (HandleRef pThis)
static internal int vtkXMLDataParser_GetAttributesEncoding_03 (HandleRef pThis)
static internal int vtkXMLDataParser_GetAttributesEncodingMaxValue_04 (HandleRef pThis)
static internal int vtkXMLDataParser_GetAttributesEncodingMinValue_05 (HandleRef pThis)
static internal IntPtr vtkXMLDataParser_GetCompressor_06 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal float vtkXMLDataParser_GetProgress_07 (HandleRef pThis)
static internal IntPtr vtkXMLDataParser_GetRootElement_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal uint vtkXMLDataParser_GetWordTypeSize_09 (HandleRef pThis, int wordType)
static internal int vtkXMLDataParser_IsA_10 (HandleRef pThis, string type)
static internal int vtkXMLDataParser_IsTypeOf_11 (string type)
static internal IntPtr vtkXMLDataParser_NewInstance_13 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkXMLDataParser_Parse_14 (HandleRef pThis)
static internal int vtkXMLDataParser_ReadAppendedData_15 (HandleRef pThis, int offset, IntPtr buffer, int startWord, int numWords, int wordType)
static internal int vtkXMLDataParser_ReadAppendedData_16 (HandleRef pThis, int offset, string buffer, int startWord, int numWords)
static internal int vtkXMLDataParser_ReadAsciiData_17 (HandleRef pThis, IntPtr buffer, int startWord, int numWords, int wordType)
static internal int vtkXMLDataParser_ReadBinaryData_18 (HandleRef pThis, IntPtr buffer, int startWord, int maxWords, int wordType)
static internal int vtkXMLDataParser_ReadInlineData_19 (HandleRef pThis, HandleRef element, int isAscii, IntPtr buffer, int startWord, int numWords, int wordType)
static internal int vtkXMLDataParser_ReadInlineData_20 (HandleRef pThis, HandleRef element, int isAscii, string buffer, int startWord, int numWords)
static internal IntPtr vtkXMLDataParser_SafeDownCast_21 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkXMLDataParser_SetAbort_22 (HandleRef pThis, int _arg)
static internal void vtkXMLDataParser_SetAttributesEncoding_23 (HandleRef pThis, int _arg)
static internal void vtkXMLDataParser_SetCompressor_24 (HandleRef pThis, HandleRef arg0)
static internal void vtkXMLDataParser_SetProgress_25 (HandleRef pThis, float _arg)

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 ( ) [static, private]

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.

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.

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

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

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

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.

Get the root element from the XML document.

Here is the call graph for this function:

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.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkXMLParser.

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.

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

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.

static internal void Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_CharacterDataHandler_01 ( HandleRef  pThis,
string  data,
int  length 
) [private]
static internal int Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_GetAbort_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_GetAttributesEncoding_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_GetAttributesEncodingMaxValue_04 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_GetAttributesEncodingMinValue_05 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_GetCompressor_06 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal float Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_GetProgress_07 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_GetRootElement_08 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal uint Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_GetWordTypeSize_09 ( HandleRef  pThis,
int  wordType 
) [private]
static internal int Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_IsA_10 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_IsTypeOf_11 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_NewInstance_13 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_Parse_14 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_ReadAppendedData_15 ( HandleRef  pThis,
int  offset,
IntPtr  buffer,
int  startWord,
int  numWords,
int  wordType 
) [private]
static internal int Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_ReadAppendedData_16 ( HandleRef  pThis,
int  offset,
string  buffer,
int  startWord,
int  numWords 
) [private]
static internal int Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_ReadAsciiData_17 ( HandleRef  pThis,
IntPtr  buffer,
int  startWord,
int  numWords,
int  wordType 
) [private]
static internal int Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_ReadBinaryData_18 ( HandleRef  pThis,
IntPtr  buffer,
int  startWord,
int  maxWords,
int  wordType 
) [private]
static internal int Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_ReadInlineData_19 ( HandleRef  pThis,
HandleRef  element,
int  isAscii,
IntPtr  buffer,
int  startWord,
int  numWords,
int  wordType 
) [private]
static internal int Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_ReadInlineData_20 ( HandleRef  pThis,
HandleRef  element,
int  isAscii,
string  buffer,
int  startWord,
int  numWords 
) [private]
static internal IntPtr Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_SafeDownCast_21 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_SetAbort_22 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_SetAttributesEncoding_23 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_SetCompressor_24 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkXMLDataParser.vtkXMLDataParser_SetProgress_25 ( HandleRef  pThis,
float  _arg 
) [private]

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: