VTK
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
vtkXMLTreeReader Class Reference

reads an XML file into a vtkTree More...

#include <vtkXMLTreeReader.h>

Inheritance diagram for vtkXMLTreeReader:
[legend]
Collaboration diagram for vtkXMLTreeReader:
[legend]

Public Types

typedef vtkTreeAlgorithm Superclass
 
- Public Types inherited from vtkTreeAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
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...
 
vtkXMLTreeReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual char * GetFileName ()
 If set, reads in the XML file specified. More...
 
virtual void SetFileName (const char *)
 If set, reads in the XML file specified. More...
 
virtual char * GetXMLString ()
 If set, and FileName is not set, reads in the XML string. More...
 
virtual void SetXMLString (const char *)
 If set, and FileName is not set, reads in the XML string. More...
 
virtual char * GetEdgePedigreeIdArrayName ()
 The name of the edge pedigree ids. More...
 
virtual void SetEdgePedigreeIdArrayName (const char *)
 The name of the edge pedigree ids. More...
 
virtual char * GetVertexPedigreeIdArrayName ()
 The name of the vertex pedigree ids. More...
 
virtual void SetVertexPedigreeIdArrayName (const char *)
 The name of the vertex pedigree ids. More...
 
virtual void SetGenerateEdgePedigreeIds (bool)
 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). More...
 
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). More...
 
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). More...
 
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). More...
 
virtual void SetGenerateVertexPedigreeIds (bool)
 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). More...
 
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). More...
 
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). More...
 
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). More...
 
virtual bool GetMaskArrays ()
 If on, makes bit arrays for each attribute with name .valid.attribute_name for each attribute. More...
 
virtual void SetMaskArrays (bool)
 If on, makes bit arrays for each attribute with name .valid.attribute_name for each attribute. More...
 
virtual void MaskArraysOn ()
 If on, makes bit arrays for each attribute with name .valid.attribute_name for each attribute. More...
 
virtual void MaskArraysOff ()
 If on, makes bit arrays for each attribute with name .valid.attribute_name for each attribute. More...
 
virtual bool GetReadCharData ()
 If on, stores the XML character data (i.e. More...
 
virtual void SetReadCharData (bool)
 If on, stores the XML character data (i.e. More...
 
virtual void ReadCharDataOn ()
 If on, stores the XML character data (i.e. More...
 
virtual void ReadCharDataOff ()
 If on, stores the XML character data (i.e. More...
 
virtual bool GetReadTagName ()
 If on, stores the XML tag name data in a field called .tagname otherwise this field is skipped. More...
 
virtual void SetReadTagName (bool)
 If on, stores the XML tag name data in a field called .tagname otherwise this field is skipped. More...
 
virtual void ReadTagNameOn ()
 If on, stores the XML tag name data in a field called .tagname otherwise this field is skipped. More...
 
virtual void ReadTagNameOff ()
 If on, stores the XML tag name data in a field called .tagname otherwise this field is skipped. More...
 
- Public Member Functions inherited from vtkTreeAlgorithm
vtkTreeAlgorithmNewInstance () const
 
int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkTreeGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkTreeGetOutput (int index)
 
void SetInputData (vtkDataObject *obj)
 Assign a data object as input. More...
 
void SetInputData (int index, vtkDataObject *obj)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
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. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual int Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual int Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, 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. More...
 
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. More...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
- Public Member Functions inherited from vtkObject
 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 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...
 
vtkCommandGetCommand (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...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. 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 vtkXMLTreeReaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLTreeReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkTreeAlgorithm
static vtkTreeAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTreeAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 Public Member Functions inherited from vtkObjectBase
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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Static Public Attributes

static const char * TagNameField
 
static const char * CharDataField
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkXMLTreeReader ()
 
 ~vtkXMLTreeReader () override
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
- Protected Member Functions inherited from vtkTreeAlgorithm
 vtkTreeAlgorithm ()
 
 ~vtkTreeAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Member Functions inherited from vtkObject
 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...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

char * FileName
 
char * XMLString
 
bool ReadCharData
 
bool ReadTagName
 
bool MaskArrays
 
char * EdgePedigreeIdArrayName
 
char * VertexPedigreeIdArrayName
 
bool GenerateEdgePedigreeIds
 
bool GenerateVertexPedigreeIds
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

reads an XML file into a vtkTree

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:

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

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

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

and the node data arrays would be as follows:

name      initials  other     age       .tagname  .chardata
------------------------------------------------------------------------------------------------
jeff      (empty)   (empty)   26         node     "  this is text in jeff's node\n  \n  \n  \n"
joe       (empty)   (empty)   (empty)    node     "\n    \n    \n  "
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)

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

.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
Examples:
vtkXMLTreeReader (Examples)
Tests:
vtkXMLTreeReader (Tests)

Definition at line 100 of file vtkXMLTreeReader.h.

Member Typedef Documentation

Definition at line 104 of file vtkXMLTreeReader.h.

Constructor & Destructor Documentation

vtkXMLTreeReader::vtkXMLTreeReader ( )
protected
vtkXMLTreeReader::~vtkXMLTreeReader ( )
overrideprotected

Member Function Documentation

static vtkXMLTreeReader* vtkXMLTreeReader::New ( )
static
static vtkTypeBool vtkXMLTreeReader::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkXMLTreeReader::IsA ( const char *  name)
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 vtkTreeAlgorithm.

static vtkXMLTreeReader* vtkXMLTreeReader::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkXMLTreeReader::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkTreeAlgorithm.

vtkXMLTreeReader* vtkXMLTreeReader::NewInstance ( ) const
void vtkXMLTreeReader::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkTreeAlgorithm.

virtual char* vtkXMLTreeReader::GetFileName ( )
virtual

If set, reads in the XML file specified.

virtual void vtkXMLTreeReader::SetFileName ( const char *  )
virtual

If set, reads in the XML file specified.

virtual char* vtkXMLTreeReader::GetXMLString ( )
virtual

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

virtual void vtkXMLTreeReader::SetXMLString ( const char *  )
virtual

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

virtual char* vtkXMLTreeReader::GetEdgePedigreeIdArrayName ( )
virtual

The name of the edge pedigree ids.

Default is "edge id".

virtual void vtkXMLTreeReader::SetEdgePedigreeIdArrayName ( const char *  )
virtual

The name of the edge pedigree ids.

Default is "edge id".

virtual char* vtkXMLTreeReader::GetVertexPedigreeIdArrayName ( )
virtual

The name of the vertex pedigree ids.

Default is "vertex id".

virtual void vtkXMLTreeReader::SetVertexPedigreeIdArrayName ( const char *  )
virtual

The name of the vertex pedigree ids.

Default is "vertex id".

virtual void vtkXMLTreeReader::SetGenerateEdgePedigreeIds ( bool  )
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 bool vtkXMLTreeReader::GetGenerateEdgePedigreeIds ( )
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 vtkXMLTreeReader::GenerateEdgePedigreeIdsOn ( )
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 vtkXMLTreeReader::GenerateEdgePedigreeIdsOff ( )
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 vtkXMLTreeReader::SetGenerateVertexPedigreeIds ( bool  )
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 bool vtkXMLTreeReader::GetGenerateVertexPedigreeIds ( )
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 vtkXMLTreeReader::GenerateVertexPedigreeIdsOn ( )
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 vtkXMLTreeReader::GenerateVertexPedigreeIdsOff ( )
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 bool vtkXMLTreeReader::GetMaskArrays ( )
virtual

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

Default is off.

virtual void vtkXMLTreeReader::SetMaskArrays ( bool  )
virtual

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

Default is off.

virtual void vtkXMLTreeReader::MaskArraysOn ( )
virtual

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

Default is off.

virtual void vtkXMLTreeReader::MaskArraysOff ( )
virtual

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

Default is off.

virtual bool vtkXMLTreeReader::GetReadCharData ( )
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 vtkXMLTreeReader::SetReadCharData ( bool  )
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 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 vtkXMLTreeReader::ReadCharDataOff ( )
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 bool vtkXMLTreeReader::GetReadTagName ( )
virtual

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

Default is on.

virtual void vtkXMLTreeReader::SetReadTagName ( bool  )
virtual

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

Default is on.

virtual void vtkXMLTreeReader::ReadTagNameOn ( )
virtual

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

Default is on.

virtual void vtkXMLTreeReader::ReadTagNameOff ( )
virtual

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

Default is on.

int vtkXMLTreeReader::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkTreeAlgorithm.

Member Data Documentation

const char* vtkXMLTreeReader::TagNameField
static

Definition at line 182 of file vtkXMLTreeReader.h.

const char* vtkXMLTreeReader::CharDataField
static

Definition at line 187 of file vtkXMLTreeReader.h.

char* vtkXMLTreeReader::FileName
protected

Definition at line 192 of file vtkXMLTreeReader.h.

char* vtkXMLTreeReader::XMLString
protected

Definition at line 193 of file vtkXMLTreeReader.h.

bool vtkXMLTreeReader::ReadCharData
protected

Definition at line 194 of file vtkXMLTreeReader.h.

bool vtkXMLTreeReader::ReadTagName
protected

Definition at line 195 of file vtkXMLTreeReader.h.

bool vtkXMLTreeReader::MaskArrays
protected

Definition at line 196 of file vtkXMLTreeReader.h.

char* vtkXMLTreeReader::EdgePedigreeIdArrayName
protected

Definition at line 197 of file vtkXMLTreeReader.h.

char* vtkXMLTreeReader::VertexPedigreeIdArrayName
protected

Definition at line 198 of file vtkXMLTreeReader.h.

bool vtkXMLTreeReader::GenerateEdgePedigreeIds
protected

Definition at line 199 of file vtkXMLTreeReader.h.

bool vtkXMLTreeReader::GenerateVertexPedigreeIds
protected

Definition at line 200 of file vtkXMLTreeReader.h.


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