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

vtkXMLTreeReader - reads an XML file into a vtkTree More...

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

List of all members.

Public Member Functions

 vtkXMLTreeReader (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkXMLTreeReader ()
 Undocumented Block.
virtual void GenerateEdgePedigreeIdsOff ()
 Set whether to use an property from the XML file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.
virtual void GenerateEdgePedigreeIdsOn ()
 Set whether to use an property from the XML file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.
virtual void GenerateVertexPedigreeIdsOff ()
 Set whether to use an property from the XML file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.
virtual void GenerateVertexPedigreeIdsOn ()
 Set whether to use an property from the XML file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.
virtual string GetEdgePedigreeIdArrayName ()
 The name of the edge pedigree ids. Default is "edge id".
virtual string GetFileName ()
 If set, reads in the XML file specified.
virtual bool GetGenerateEdgePedigreeIds ()
 Set whether to use an property from the XML file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.
virtual bool GetGenerateVertexPedigreeIds ()
 Set whether to use an property from the XML file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.
virtual bool GetMaskArrays ()
 If on, makes bit arrays for each attribute with name .valid.attribute_name for each attribute. Default is off.
virtual bool GetReadCharData ()
 If on, stores the XML character data (i.e. textual data between tags) into an array named CharDataField, otherwise this field is skipped. Default is off.
virtual bool GetReadTagName ()
 If on, stores the XML tag name data in a field called .tagname otherwise this field is skipped. Default is on.
virtual string GetVertexPedigreeIdArrayName ()
 The name of the vertex pedigree ids. Default is "vertex id".
virtual string GetXMLString ()
 If set, and FileName is not set, reads in the XML string.
override int IsA (string type)
 Undocumented Block.
virtual void MaskArraysOff ()
 If on, makes bit arrays for each attribute with name .valid.attribute_name for each attribute. Default is off.
virtual void MaskArraysOn ()
 If on, makes bit arrays for each attribute with name .valid.attribute_name for each attribute. Default is off.
new vtkXMLTreeReader NewInstance ()
 Undocumented Block.
virtual void ReadCharDataOff ()
 If on, stores the XML character data (i.e. textual data between tags) into an array named CharDataField, otherwise this field is skipped. Default is off.
virtual void ReadCharDataOn ()
 If on, stores the XML character data (i.e. textual data between tags) into an array named CharDataField, otherwise this field is skipped. Default is off.
virtual void ReadTagNameOff ()
 If on, stores the XML tag name data in a field called .tagname otherwise this field is skipped. Default is on.
virtual void ReadTagNameOn ()
 If on, stores the XML tag name data in a field called .tagname otherwise this field is skipped. Default is on.
virtual void SetEdgePedigreeIdArrayName (string _arg)
 The name of the edge pedigree ids. Default is "edge id".
virtual void SetFileName (string _arg)
 If set, reads in the XML file specified.
virtual void SetGenerateEdgePedigreeIds (bool _arg)
 Set whether to use an property from the XML file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.
virtual void SetGenerateVertexPedigreeIds (bool _arg)
 Set whether to use an property from the XML file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.
virtual void SetMaskArrays (bool _arg)
 If on, makes bit arrays for each attribute with name .valid.attribute_name for each attribute. Default is off.
virtual void SetReadCharData (bool _arg)
 If on, stores the XML character data (i.e. textual data between tags) into an array named CharDataField, otherwise this field is skipped. Default is off.
virtual void SetReadTagName (bool _arg)
 If on, stores the XML tag name data in a field called .tagname otherwise this field is skipped. Default is on.
virtual void SetVertexPedigreeIdArrayName (string _arg)
 The name of the vertex pedigree ids. Default is "vertex id".
virtual void SetXMLString (string _arg)
 If set, and FileName is not set, reads in the XML string.

Static Public Member Functions

static new vtkXMLTreeReader New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkXMLTreeReader SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkXMLTreeReader"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "16vtkXMLTreeReader"
 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 vtkXMLTreeReader_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkXMLTreeReader_GenerateEdgePedigreeIdsOff_01 (HandleRef pThis)
static internal void vtkXMLTreeReader_GenerateEdgePedigreeIdsOn_02 (HandleRef pThis)
static internal void vtkXMLTreeReader_GenerateVertexPedigreeIdsOff_03 (HandleRef pThis)
static internal void vtkXMLTreeReader_GenerateVertexPedigreeIdsOn_04 (HandleRef pThis)
static internal IntPtr vtkXMLTreeReader_GetEdgePedigreeIdArrayName_05 (HandleRef pThis)
static internal IntPtr vtkXMLTreeReader_GetFileName_06 (HandleRef pThis)
static internal byte vtkXMLTreeReader_GetGenerateEdgePedigreeIds_07 (HandleRef pThis)
static internal byte vtkXMLTreeReader_GetGenerateVertexPedigreeIds_08 (HandleRef pThis)
static internal byte vtkXMLTreeReader_GetMaskArrays_09 (HandleRef pThis)
static internal byte vtkXMLTreeReader_GetReadCharData_10 (HandleRef pThis)
static internal byte vtkXMLTreeReader_GetReadTagName_11 (HandleRef pThis)
static internal IntPtr vtkXMLTreeReader_GetVertexPedigreeIdArrayName_12 (HandleRef pThis)
static internal IntPtr vtkXMLTreeReader_GetXMLString_13 (HandleRef pThis)
static internal int vtkXMLTreeReader_IsA_14 (HandleRef pThis, string type)
static internal int vtkXMLTreeReader_IsTypeOf_15 (string type)
static internal void vtkXMLTreeReader_MaskArraysOff_16 (HandleRef pThis)
static internal void vtkXMLTreeReader_MaskArraysOn_17 (HandleRef pThis)
static internal IntPtr vtkXMLTreeReader_NewInstance_19 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkXMLTreeReader_ReadCharDataOff_20 (HandleRef pThis)
static internal void vtkXMLTreeReader_ReadCharDataOn_21 (HandleRef pThis)
static internal void vtkXMLTreeReader_ReadTagNameOff_22 (HandleRef pThis)
static internal void vtkXMLTreeReader_ReadTagNameOn_23 (HandleRef pThis)
static internal IntPtr vtkXMLTreeReader_SafeDownCast_24 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkXMLTreeReader_SetEdgePedigreeIdArrayName_25 (HandleRef pThis, string _arg)
static internal void vtkXMLTreeReader_SetFileName_26 (HandleRef pThis, string _arg)
static internal void vtkXMLTreeReader_SetGenerateEdgePedigreeIds_27 (HandleRef pThis, byte _arg)
static internal void vtkXMLTreeReader_SetGenerateVertexPedigreeIds_28 (HandleRef pThis, byte _arg)
static internal void vtkXMLTreeReader_SetMaskArrays_29 (HandleRef pThis, byte _arg)
static internal void vtkXMLTreeReader_SetReadCharData_30 (HandleRef pThis, byte _arg)
static internal void vtkXMLTreeReader_SetReadTagName_31 (HandleRef pThis, byte _arg)
static internal void vtkXMLTreeReader_SetVertexPedigreeIdArrayName_32 (HandleRef pThis, string _arg)
static internal void vtkXMLTreeReader_SetXMLString_33 (HandleRef pThis, string _arg)

Static Private Member Functions

static vtkXMLTreeReader ()
 Automatically generated type registration mechanics.

Detailed Description

vtkXMLTreeReader - reads an XML file into a vtkTree

Description vtkXMLTreeReader parses an XML file and uses the nesting structure of the XML tags to generate a tree. Node attributes are assigned to node arrays, and the special arrays .tagname and .chardata contain the tag type and the text internal to the tag, respectively. The arrays are of type vtkStringArray. There is an array for each attribute type in the XML file, even if it appears in only one tag. If an attribute is missing from a tag, its value is the empty string.

If MaskArrays is on (the default is off), the filter will additionally make bit arrays whose names are prepended with ".valid." which are 1 if the element contains that attribute, and 0 otherwise.

For example, the XML file containing the text: <pre> &lt;node name="jeff" age="26"&gt; this is text in jeff's node &lt;node name="joe"&gt; &lt;node name="al" initials="amb" other="something"/&gt; &lt;node name="dave" age="30"/&gt; &lt;/node&gt; &lt;node name="lisa"&gt;this is text in lisa's node&lt;/node&gt; &lt;node name="darlene" age="29"/&gt; &lt;/node&gt; </pre>

would be parsed into a tree with the following node IDs and structure:

<pre> 0 (jeff) - children: 1 (joe), 4 (lisa), 5 (darlene) 1 (joe) - children: 2 (al), 3 (dave) 2 (al) 3 (dave) 4 (lisa) 5 (darlene) </pre>

and the node data arrays would be as follows:

<pre> name initials other age .tagname .chardata ------------------------------------------------------------------------------------------------ jeff (empty) (empty) 26 node " this is text in jeff's node



" joe (empty) (empty) (empty) node "


" al amb something (empty) node (empty) dave (empty) (empty) 30 node (empty) lisa (empty) (empty) (empty) node "this is text in lisa's node" darlene (empty) (empty) 29 node (empty) </pre>

There would also be the following bit arrays if MaskArrays is on:

<pre> .valid.name .valid.initials .valid.other .valid.age --------------------------------------------------------- 1 0 0 1 1 0 0 0 1 1 1 0 1 0 0 1 1 0 0 0 1 0 0 1 </pre>


Constructor & Destructor Documentation

static Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader ( ) [static, private]

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

override void Kitware.VTK.vtkXMLTreeReader.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.vtkTreeAlgorithm.

Set whether to use an property from the XML file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.

Set whether to use an property from the XML file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.

Set whether to use an property from the XML file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.

Set whether to use an property from the XML file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.

The name of the edge pedigree ids. Default is "edge id".

virtual string Kitware.VTK.vtkXMLTreeReader.GetFileName ( ) [virtual]

If set, reads in the XML file specified.

Set whether to use an property from the XML file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.

Set whether to use an property from the XML file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.

virtual bool Kitware.VTK.vtkXMLTreeReader.GetMaskArrays ( ) [virtual]

If on, makes bit arrays for each attribute with name .valid.attribute_name for each attribute. Default is off.

If on, stores the XML character data (i.e. textual data between tags) into an array named CharDataField, otherwise this field is skipped. Default is off.

virtual bool Kitware.VTK.vtkXMLTreeReader.GetReadTagName ( ) [virtual]

If on, stores the XML tag name data in a field called .tagname otherwise this field is skipped. Default is on.

The name of the vertex pedigree ids. Default is "vertex id".

virtual string Kitware.VTK.vtkXMLTreeReader.GetXMLString ( ) [virtual]

If set, and FileName is not set, reads in the XML string.

override int Kitware.VTK.vtkXMLTreeReader.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.

static new int Kitware.VTK.vtkXMLTreeReader.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.

virtual void Kitware.VTK.vtkXMLTreeReader.MaskArraysOff ( ) [virtual]

If on, makes bit arrays for each attribute with name .valid.attribute_name for each attribute. Default is off.

virtual void Kitware.VTK.vtkXMLTreeReader.MaskArraysOn ( ) [virtual]

If on, makes bit arrays for each attribute with name .valid.attribute_name for each attribute. Default is off.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.

If on, stores the XML character data (i.e. textual data between tags) into an array named CharDataField, otherwise this field is skipped. Default is off.

virtual void Kitware.VTK.vtkXMLTreeReader.ReadCharDataOn ( ) [virtual]

If on, stores the XML character data (i.e. textual data between tags) into an array named CharDataField, otherwise this field is skipped. Default is off.

virtual void Kitware.VTK.vtkXMLTreeReader.ReadTagNameOff ( ) [virtual]

If on, stores the XML tag name data in a field called .tagname otherwise this field is skipped. Default is on.

virtual void Kitware.VTK.vtkXMLTreeReader.ReadTagNameOn ( ) [virtual]

If on, stores the XML tag name data in a field called .tagname otherwise this field is skipped. Default is on.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkXMLTreeReader.SetEdgePedigreeIdArrayName ( string  _arg) [virtual]

The name of the edge pedigree ids. Default is "edge id".

virtual void Kitware.VTK.vtkXMLTreeReader.SetFileName ( string  _arg) [virtual]

If set, reads in the XML file specified.

virtual void Kitware.VTK.vtkXMLTreeReader.SetGenerateEdgePedigreeIds ( bool  _arg) [virtual]

Set whether to use an property from the XML file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.

virtual void Kitware.VTK.vtkXMLTreeReader.SetGenerateVertexPedigreeIds ( bool  _arg) [virtual]

Set whether to use an property from the XML file as pedigree ids (off), or generate a new array with integer values starting at zero (on). Default is on.

virtual void Kitware.VTK.vtkXMLTreeReader.SetMaskArrays ( bool  _arg) [virtual]

If on, makes bit arrays for each attribute with name .valid.attribute_name for each attribute. Default is off.

virtual void Kitware.VTK.vtkXMLTreeReader.SetReadCharData ( bool  _arg) [virtual]

If on, stores the XML character data (i.e. textual data between tags) into an array named CharDataField, otherwise this field is skipped. Default is off.

virtual void Kitware.VTK.vtkXMLTreeReader.SetReadTagName ( bool  _arg) [virtual]

If on, stores the XML tag name data in a field called .tagname otherwise this field is skipped. Default is on.

virtual void Kitware.VTK.vtkXMLTreeReader.SetVertexPedigreeIdArrayName ( string  _arg) [virtual]

The name of the vertex pedigree ids. Default is "vertex id".

virtual void Kitware.VTK.vtkXMLTreeReader.SetXMLString ( string  _arg) [virtual]

If set, and FileName is not set, reads in the XML string.

static internal void Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_GenerateEdgePedigreeIdsOff_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_GenerateEdgePedigreeIdsOn_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_GenerateVertexPedigreeIdsOff_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_GenerateVertexPedigreeIdsOn_04 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_GetEdgePedigreeIdArrayName_05 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_GetFileName_06 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_GetGenerateEdgePedigreeIds_07 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_GetGenerateVertexPedigreeIds_08 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_GetMaskArrays_09 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_GetReadCharData_10 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_GetReadTagName_11 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_GetVertexPedigreeIdArrayName_12 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_GetXMLString_13 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_IsA_14 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_IsTypeOf_15 ( string  type) [private]
static internal void Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_MaskArraysOff_16 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_MaskArraysOn_17 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_NewInstance_19 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_ReadCharDataOff_20 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_ReadCharDataOn_21 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_ReadTagNameOff_22 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_ReadTagNameOn_23 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_SafeDownCast_24 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_SetEdgePedigreeIdArrayName_25 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_SetFileName_26 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_SetGenerateEdgePedigreeIds_27 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_SetGenerateVertexPedigreeIds_28 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_SetMaskArrays_29 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_SetReadCharData_30 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_SetReadTagName_31 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_SetVertexPedigreeIdArrayName_32 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkXMLTreeReader.vtkXMLTreeReader_SetXMLString_33 ( HandleRef  pThis,
string  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkXMLTreeReader.MRClassNameKey = "16vtkXMLTreeReader" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.


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