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.
|
| | vtkTreeAlgorithm (IntPtr rawCppThis, bool callDisposalMethod, bool strong) |
| | Automatically generated constructor - called from generated code. DO NOT call directly.
|
| | vtkTreeAlgorithm () |
| | *Undocumented Block
|
| vtkTree | GetOutput () |
| | Get the output data object for a port on this algorithm.
|
| vtkTree | GetOutput (int index) |
| | Get the output data object for a port on this algorithm.
|
| void | SetInput (vtkDataObject obj) |
| | Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.
|
| void | SetInput (int index, vtkDataObject obj) |
| | Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.
|
| | vtkAlgorithm (IntPtr rawCppThis, bool callDisposalMethod, bool strong) |
| | Automatically generated constructor - called from generated code. DO NOT call directly.
|
| | vtkAlgorithm () |
| | *Undocumented Block
|
| override void | Register (vtkObjectBase o) |
| | Participate in garbage collection.
|
| virtual void | AbortExecuteOff () |
| | Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
|
| virtual void | AbortExecuteOn () |
| | Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
|
| virtual void | AddInputConnection (int port, vtkAlgorithmOutput input) |
| | Add a connection to the given input port index. See SetInputConnection() for details on input connections. This method is the complement to RemoveInputConnection() in that it adds only the connection specified without affecting other connections. Typical usage is.
|
| virtual void | AddInputConnection (vtkAlgorithmOutput input) |
| | Add a connection to the given input port index. See SetInputConnection() for details on input connections. This method is the complement to RemoveInputConnection() in that it adds only the connection specified without affecting other connections. Typical usage is.
|
| virtual double | ComputePriority () |
| | Returns the priority of the piece described by the current update extent. The priority is a number between 0.0 and 1.0 with 0 meaning skippable (REQUEST_DATA not needed) and 1.0 meaning important.
|
| void | ConvertTotalInputToPortConnection (int ind, ref int port, ref int conn) |
| | Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
|
| virtual int | GetAbortExecute () |
| | Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
|
| virtual uint | GetErrorCode () |
| | The error code contains a possible error that occured while reading or writing the file.
|
| vtkExecutive | GetExecutive () |
| | Get this algorithm's executive. If it has none, a default executive will be created.
|
| virtual vtkInformation | GetInformation () |
| | Set/Get the information object associated with this algorithm.
|
| vtkInformation | GetInputArrayInformation (int idx) |
| | Get the info object for the specified input array to this algorithm.
|
| vtkAlgorithmOutput | GetInputConnection (int port, int index) |
| | Get the algorithm output port connected to an input port.
|
| vtkDataObject | GetInputDataObject (int port, int connection) |
| | Get the data object that will contain the algorithm input for the given port and given connection.
|
| vtkInformation | GetInputPortInformation (int port) |
| | Get the information object associated with an input port. There is one input port per kind of input to the algorithm. Each input port tells executives what kind of data and downstream requests this algorithm can handle for that input.
|
| int | GetNumberOfInputConnections (int port) |
| | Get the number of inputs currently connected to a port.
|
| int | GetNumberOfInputPorts () |
| | Get the number of input ports used by the algorithm.
|
| int | GetNumberOfOutputPorts () |
| | Get the number of output ports provided by the algorithm.
|
| vtkDataObject | GetOutputDataObject (int port) |
| | Get the data object that will contain the algorithm output for the given port.
|
| vtkAlgorithmOutput | GetOutputPort (int index) |
| | Get a proxy object corresponding to the given output port of this algorithm. The proxy object can be passed to another algorithm's SetInputConnection(), AddInputConnection(), and RemoveInputConnection() methods to modify pipeline connectivity.
|
| vtkAlgorithmOutput | GetOutputPort () |
| | Get a proxy object corresponding to the given output port of this algorithm. The proxy object can be passed to another algorithm's SetInputConnection(), AddInputConnection(), and RemoveInputConnection() methods to modify pipeline connectivity.
|
| vtkInformation | GetOutputPortInformation (int port) |
| | Get the information object associated with an output port. There is one output port per output from the algorithm. Each output port tells executives what kind of upstream requests this algorithm can handle for that output.
|
| virtual double | GetProgress () |
| | Set/Get the execution progress of a process object.
|
| virtual double | GetProgressMaxValue () |
| | Set/Get the execution progress of a process object.
|
| virtual double | GetProgressMinValue () |
| | Set/Get the execution progress of a process object.
|
| virtual string | GetProgressText () |
| | Set the current text message associated with the progress state. This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData().
|
| virtual int | GetReleaseDataFlag () |
| | Turn release data flag on or off for all output ports.
|
| int | GetTotalNumberOfInputConnections () |
| | Get the total number of inputs for this algorithm.
|
| int | HasExecutive () |
| | Check whether this algorithm has an assigned executive. This will NOT create a default executive.
|
| virtual int | ModifyRequest (vtkInformation request, int when) |
| | This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. The default implementation is empty. Returns 1 on success, 0 on failure. When can be either vtkExecutive::BeforeForward or vtkExecutive::AfterForward.
|
| int | ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector outInfo) |
| | Version of ProcessRequest() that is wrapped. This converts the collection to an array and calls the other version.
|
| void | ReleaseDataFlagOff () |
| | Turn release data flag on or off for all output ports.
|
| void | ReleaseDataFlagOn () |
| | Turn release data flag on or off for all output ports.
|
| void | RemoveAllInputs () |
| | Remove all the input data.
|
| virtual void | RemoveInputConnection (int port, vtkAlgorithmOutput input) |
| | Remove a connection from the given input port index. See SetInputConnection() for details on input connection. This method is the complement to AddInputConnection() in that it removes only the connection specified without affecting other connections. Typical usage is.
|
| virtual void | SetAbortExecute (int _arg) |
| | Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
|
| virtual void | SetExecutive (vtkExecutive executive) |
| | Set this algorithm's executive. This algorithm is removed from any executive to which it has previously been assigned and then assigned to the given executive.
|
| virtual void | SetInformation (vtkInformation arg0) |
| | Set/Get the information object associated with this algorithm.
|
| virtual void | SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, string name) |
| | Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
|
| virtual void | SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType) |
| | Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
|
| virtual void | SetInputArrayToProcess (int idx, vtkInformation info) |
| | Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
|
| virtual void | SetInputArrayToProcess (int idx, int port, int connection, string fieldAssociation, string attributeTypeorName) |
| | String based versions of SetInputArrayToProcess(). Because fieldAssociation and fieldAttributeType are enums, they cannot be easily accessed from scripting language. These methods provides an easy and safe way of passing association and attribute type information. Field association is one of the following:
|
| virtual void | SetInputConnection (int port, vtkAlgorithmOutput input) |
| | Set the connection for the given input port index. Each input port of a filter has a specific purpose. A port may have zero or more connections and the required number is specified by each filter. Setting the connection with this method removes all other connections from the port. To add more than one connection use AddInputConnection().
|
| virtual void | SetInputConnection (vtkAlgorithmOutput input) |
| | Set the connection for the given input port index. Each input port of a filter has a specific purpose. A port may have zero or more connections and the required number is specified by each filter. Setting the connection with this method removes all other connections from the port. To add more than one connection use AddInputConnection().
|
| virtual void | SetProgress (double _arg) |
| | Set/Get the execution progress of a process object.
|
| void | SetProgressText (string ptext) |
| | Set the current text message associated with the progress state. This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData().
|
| virtual void | SetReleaseDataFlag (int arg0) |
| | Turn release data flag on or off for all output ports.
|
| virtual void | Update () |
| | Bring this algorithm's outputs up-to-date.
|
| int | UpdateExtentIsEmpty (vtkDataObject output) |
| | This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. The source uses this call to determine whether to call Execute.
|
| int | UpdateExtentIsEmpty (vtkInformation pinfo, int extentType) |
| | This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. The source uses this call to determine whether to call Execute.
|
| virtual void | UpdateInformation () |
| | Backward compatibility method to invoke UpdateInformation on executive.
|
| void | UpdateProgress (double amount) |
| | Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).
|
| virtual void | UpdateWholeExtent () |
| | Bring this algorithm's outputs up-to-date.
|
| | 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...
|
| | 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 | 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.)
|
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> <node name="jeff" age="26"> this is text in jeff's node <node name="joe"> <node name="al" initials="amb" other="something"/> <node name="dave" age="30"/> </node> <node name="lisa">this is text in lisa's node</node> <node name="darlene" age="29"/> </node> </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>
Public Member Functions inherited from Kitware.VTK.vtkTreeAlgorithm