VTK  9.1.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkXMLReader Class Referenceabstract

Superclass for VTK's XML format readers. More...

#include <vtkXMLReader.h>

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

Public Types

enum  FieldType { POINT_DATA , CELL_DATA , OTHER }
 
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...
 
vtkXMLReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual int CanReadFile (VTK_FILEPATH const char *name)
 Test whether the file (type) with the given name can be read by this reader. More...
 
virtual void CopyOutputInformation (vtkInformation *vtkNotUsed(outInfo), int vtkNotUsed(port))
 
virtual int GetNumberOfTimeSteps ()
 
vtkXMLDataParserGetXMLParser ()
 Returns the internal XML parser. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. More...
 
 vtkSetFilePathMacro (FileName)
 Get/Set the name of the input file. More...
 
 vtkGetFilePathMacro (FileName)
 Get/Set the name of the input file. More...
 
virtual void SetReadFromInputString (vtkTypeBool)
 Enable reading from an InputString instead of the default, a file. More...
 
virtual vtkTypeBool GetReadFromInputString ()
 Enable reading from an InputString instead of the default, a file. More...
 
virtual void ReadFromInputStringOn ()
 Enable reading from an InputString instead of the default, a file. More...
 
virtual void ReadFromInputStringOff ()
 Enable reading from an InputString instead of the default, a file. More...
 
void SetInputString (const std::string &s)
 Enable reading from an InputString instead of the default, a file. More...
 
vtkDataSetGetOutputAsDataSet ()
 Get the output as a vtkDataSet pointer. More...
 
vtkDataSetGetOutputAsDataSet (int index)
 Get the output as a vtkDataSet pointer. More...
 
virtual vtkDataArraySelectionGetPointDataArraySelection ()
 Get the data array selection tables used to configure which data arrays are loaded by the reader. More...
 
virtual vtkDataArraySelectionGetCellDataArraySelection ()
 Get the data array selection tables used to configure which data arrays are loaded by the reader. More...
 
virtual vtkDataArraySelectionGetColumnArraySelection ()
 Get the data array selection tables used to configure which data arrays are loaded by the reader. More...
 
int GetNumberOfPointArrays ()
 Get the number of point, cell or column arrays available in the input. More...
 
int GetNumberOfCellArrays ()
 Get the number of point, cell or column arrays available in the input. More...
 
int GetNumberOfColumnArrays ()
 Get the number of point, cell or column arrays available in the input. More...
 
int GetNumberOfTimeDataArrays () const
 Getters for time data array candidates. More...
 
const char * GetTimeDataArray (int idx) const
 Getters for time data array candidates. More...
 
virtual vtkStringArrayGetTimeDataStringArray ()
 Getters for time data array candidates. More...
 
virtual char * GetActiveTimeDataArrayName ()
 Setter / Getter on ActiveTimeDataArrayName. More...
 
virtual void SetActiveTimeDataArrayName (const char *)
 Setter / Getter on ActiveTimeDataArrayName. More...
 
const char * GetPointArrayName (int index)
 Get the name of the point, cell, column or time array with the given index in the input. More...
 
const char * GetCellArrayName (int index)
 Get the name of the point, cell, column or time array with the given index in the input. More...
 
const char * GetColumnArrayName (int index)
 Get the name of the point, cell, column or time array with the given index in the input. More...
 
int GetPointArrayStatus (const char *name)
 Get/Set whether the point, cell, column or time array with the given name is to be read. More...
 
int GetCellArrayStatus (const char *name)
 Get/Set whether the point, cell, column or time array with the given name is to be read. More...
 
void SetPointArrayStatus (const char *name, int status)
 Get/Set whether the point, cell, column or time array with the given name is to be read. More...
 
void SetCellArrayStatus (const char *name, int status)
 Get/Set whether the point, cell, column or time array with the given name is to be read. More...
 
int GetColumnArrayStatus (const char *name)
 Get/Set whether the point, cell, column or time array with the given name is to be read. More...
 
void SetColumnArrayStatus (const char *name, int status)
 Get/Set whether the point, cell, column or time array with the given name is to be read. More...
 
virtual void SetTimeStep (int)
 Which TimeStep to read. More...
 
virtual int GetTimeStep ()
 Which TimeStep to read. More...
 
virtual int * GetTimeStepRange ()
 Which TimeStepRange to read. More...
 
virtual void GetTimeStepRange (int &, int &)
 Which TimeStepRange to read. More...
 
virtual void GetTimeStepRange (int[2])
 Which TimeStepRange to read. More...
 
virtual void SetTimeStepRange (int, int)
 Which TimeStepRange to read. More...
 
void SetTimeStepRange (int[2])
 Which TimeStepRange to read. More...
 
void SetReaderErrorObserver (vtkCommand *)
 Set/get the ErrorObserver for the internal reader This is useful for applications that want to catch error messages. More...
 
virtual vtkCommandGetReaderErrorObserver ()
 Set/get the ErrorObserver for the internal reader This is useful for applications that want to catch error messages. More...
 
void SetParserErrorObserver (vtkCommand *)
 Set/get the ErrorObserver for the internal xml parser This is useful for applications that want to catch error messages. More...
 
virtual vtkCommandGetParserErrorObserver ()
 Set/get the ErrorObserver for the internal xml parser This is useful for applications that want to catch error messages. More...
 
- Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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...
 
virtual vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. More...
 
vtkTypeBool 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 vtkTypeBool 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 vtkTypeBool 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...
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (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 PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. 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 vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. 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 vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLReaderSafeDownCast (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 vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkXMLReader ()
 
 ~vtkXMLReader () override
 
virtual int ReadXMLInformation ()
 
virtual void ReadXMLData ()
 
virtual const char * GetDataSetName ()=0
 
virtual int CanReadFileVersion (int major, int minor)
 
virtual void SetupEmptyOutput ()=0
 
virtual void SetupOutputInformation (vtkInformation *vtkNotUsed(outInfo))
 
virtual void SetupOutputData ()
 
virtual int ReadPrimaryElement (vtkXMLDataElement *ePrimary)
 
virtual int ReadVTKFile (vtkXMLDataElement *eVTKFile)
 
int GetLocalDataType (vtkXMLDataElement *da, int datatype)
 If the IdType argument is present in the provided XMLDataElement and the provided dataType has the same size with VTK_ID_TYPE on this build of VTK, returns VTK_ID_TYPE. More...
 
vtkAbstractArrayCreateArray (vtkXMLDataElement *da)
 
int CreateInformationKey (vtkXMLDataElement *eInfoKey, vtkInformation *info)
 
bool ReadInformation (vtkXMLDataElement *infoRoot, vtkInformation *info)
 
virtual int OpenStream ()
 
virtual void CloseStream ()
 
virtual int OpenVTKFile ()
 
virtual void CloseVTKFile ()
 
virtual int OpenVTKString ()
 
virtual void CloseVTKString ()
 
virtual void CreateXMLParser ()
 
virtual void DestroyXMLParser ()
 
void SetupCompressor (const char *type)
 
int CanReadFileVersionString (const char *version)
 
virtual int CanReadFileWithDataType (const char *dsname)
 This method is used by CanReadFile() to check if the reader can read an XML with the primary element with the given name. More...
 
virtual int GetFileMajorVersion ()
 
virtual int GetFileMinorVersion ()
 
int IntersectExtents (int *extent1, int *extent2, int *result)
 
int Min (int a, int b)
 
int Max (int a, int b)
 
void ComputePointDimensions (int *extent, int *dimensions)
 
void ComputePointIncrements (int *extent, vtkIdType *increments)
 
void ComputeCellDimensions (int *extent, int *dimensions)
 
void ComputeCellIncrements (int *extent, vtkIdType *increments)
 
vtkIdType GetStartTuple (int *extent, vtkIdType *increments, int i, int j, int k)
 
void ReadAttributeIndices (vtkXMLDataElement *eDSA, vtkDataSetAttributes *dsa)
 
char ** CreateStringArray (int numStrings)
 
void DestroyStringArray (int numStrings, char **strings)
 
virtual int ReadArrayValues (vtkXMLDataElement *da, vtkIdType arrayIndex, vtkAbstractArray *array, vtkIdType startIndex, vtkIdType numValues, FieldType type=OTHER)
 
void SetDataArraySelections (vtkXMLDataElement *eDSA, vtkDataArraySelection *sel)
 
int SetFieldDataInfo (vtkXMLDataElement *eDSA, int association, vtkIdType numTuples, vtkInformationVector *(&infoVector))
 
int PointDataArrayIsEnabled (vtkXMLDataElement *ePDA)
 
int CellDataArrayIsEnabled (vtkXMLDataElement *eCDA)
 
virtual void SqueezeOutputArrays (vtkDataObject *)
 
void MarkIdTypeArrays (vtkXMLDataElement *da)
 XML files have not consistently saved out adequate meta-data in past to correctly create vtkIdTypeArray for global ids and pedigree ids. More...
 
virtual void GetProgressRange (float *range)
 
virtual void SetProgressRange (const float range[2], int curStep, int numSteps)
 
virtual void SetProgressRange (const float range[2], int curStep, const float *fractions)
 
virtual void UpdateProgressDiscrete (float progress)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestDataObject (vtkInformation *vtkNotUsed(request), vtkInformationVector **vtkNotUsed(inputVector), vtkInformationVector *vtkNotUsed(outputVector))
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
void SetNumberOfTimeSteps (int num)
 
vtkDataObjectGetCurrentOutput ()
 
vtkInformationGetCurrentOutputInformation ()
 
virtual void ConvertGhostLevelsToGhostType (FieldType, vtkAbstractArray *, vtkIdType, vtkIdType)
 
void ReadFieldData ()
 
- Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm. More...
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 Fill the output port information objects for this algorithm. More...
 
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 RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static void SelectionModifiedCallback (vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
 
static int IsTimeStepInArray (int timestep, int *timesteps, int length)
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Protected Attributes

vtkXMLDataParserXMLParser
 
vtkXMLDataElementFieldDataElement
 
char * FileName
 
istream * Stream
 
vtkTypeBool ReadFromInputString
 
std::string InputString
 
vtkDataArraySelectionPointDataArraySelection
 
vtkDataArraySelectionCellDataArraySelection
 
vtkDataArraySelectionColumnArraySelection
 
vtkStringArrayTimeDataStringArray
 
char * ActiveTimeDataArrayName
 Name of the field-data array used to determine the time for the dataset being read. More...
 
vtkSmartPointer< vtkDataArrayTimeDataArray
 Populated in ReadXMLInformation from the field data for the array chosen using ActiveTimeDataArrayName, if any. More...
 
vtkCallbackCommandSelectionObserver
 
int InformationError
 
int DataError
 
float ProgressRange [2]
 
vtkTimeStamp ReadMTime
 
int ReadError
 
int AxesEmpty [3]
 
int TimeStep
 
int CurrentTimeStep
 
int NumberOfTimeSteps
 
int * TimeSteps
 
int TimeStepRange [2]
 
int InReadData
 
- 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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Superclass for VTK's XML format readers.

vtkXMLReader uses vtkXMLDataParser to parse a VTK XML input file. Concrete subclasses then traverse the parsed file structure and extract data.

Online Examples:

Definition at line 65 of file vtkXMLReader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 68 of file vtkXMLReader.h.

Member Enumeration Documentation

◆ FieldType

Enumerator
POINT_DATA 
CELL_DATA 
OTHER 

Definition at line 71 of file vtkXMLReader.h.

Constructor & Destructor Documentation

◆ vtkXMLReader()

vtkXMLReader::vtkXMLReader ( )
protected

◆ ~vtkXMLReader()

vtkXMLReader::~vtkXMLReader ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkXMLReader::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkXMLReader::IsA ( const char *  name)
virtual

◆ SafeDownCast()

static vtkXMLReader * vtkXMLReader::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkXMLReader::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkXMLReader * vtkXMLReader::NewInstance ( ) const

◆ PrintSelf()

void vtkXMLReader::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 vtkAlgorithm.

Reimplemented in vtkXMLRectilinearGridReader, vtkXMLStructuredDataReader, vtkXMLStructuredGridReader, vtkXMLTableReader, vtkXMLUniformGridAMRReader, vtkXMLUnstructuredDataReader, and vtkXMLUnstructuredGridReader.

◆ vtkSetFilePathMacro()

vtkXMLReader::vtkSetFilePathMacro ( FileName  )

Get/Set the name of the input file.

◆ vtkGetFilePathMacro()

vtkXMLReader::vtkGetFilePathMacro ( FileName  )

Get/Set the name of the input file.

◆ SetReadFromInputString()

virtual void vtkXMLReader::SetReadFromInputString ( vtkTypeBool  )
virtual

Enable reading from an InputString instead of the default, a file.

◆ GetReadFromInputString()

virtual vtkTypeBool vtkXMLReader::GetReadFromInputString ( )
virtual

Enable reading from an InputString instead of the default, a file.

◆ ReadFromInputStringOn()

virtual void vtkXMLReader::ReadFromInputStringOn ( )
virtual

Enable reading from an InputString instead of the default, a file.

◆ ReadFromInputStringOff()

virtual void vtkXMLReader::ReadFromInputStringOff ( )
virtual

Enable reading from an InputString instead of the default, a file.

◆ SetInputString()

void vtkXMLReader::SetInputString ( const std::string &  s)
inline

Enable reading from an InputString instead of the default, a file.

Definition at line 93 of file vtkXMLReader.h.

◆ CanReadFile()

virtual int vtkXMLReader::CanReadFile ( VTK_FILEPATH const char *  name)
virtual

Test whether the file (type) with the given name can be read by this reader.

If the file has a newer version than the reader, we still say we can read the file type and we fail later, when we try to read the file. This enables clients (ParaView) to distinguish between failures when we need to look for another reader and failures when we don't.

◆ GetOutputAsDataSet() [1/2]

vtkDataSet * vtkXMLReader::GetOutputAsDataSet ( )

Get the output as a vtkDataSet pointer.

◆ GetOutputAsDataSet() [2/2]

vtkDataSet * vtkXMLReader::GetOutputAsDataSet ( int  index)

Get the output as a vtkDataSet pointer.

◆ GetPointDataArraySelection()

virtual vtkDataArraySelection * vtkXMLReader::GetPointDataArraySelection ( )
virtual

Get the data array selection tables used to configure which data arrays are loaded by the reader.

◆ GetCellDataArraySelection()

virtual vtkDataArraySelection * vtkXMLReader::GetCellDataArraySelection ( )
virtual

Get the data array selection tables used to configure which data arrays are loaded by the reader.

◆ GetColumnArraySelection()

virtual vtkDataArraySelection * vtkXMLReader::GetColumnArraySelection ( )
virtual

Get the data array selection tables used to configure which data arrays are loaded by the reader.

◆ GetNumberOfPointArrays()

int vtkXMLReader::GetNumberOfPointArrays ( )

Get the number of point, cell or column arrays available in the input.

◆ GetNumberOfCellArrays()

int vtkXMLReader::GetNumberOfCellArrays ( )

Get the number of point, cell or column arrays available in the input.

◆ GetNumberOfColumnArrays()

int vtkXMLReader::GetNumberOfColumnArrays ( )

Get the number of point, cell or column arrays available in the input.

◆ GetNumberOfTimeDataArrays()

int vtkXMLReader::GetNumberOfTimeDataArrays ( ) const

Getters for time data array candidates.

◆ GetTimeDataArray()

const char * vtkXMLReader::GetTimeDataArray ( int  idx) const

Getters for time data array candidates.

◆ GetTimeDataStringArray()

virtual vtkStringArray * vtkXMLReader::GetTimeDataStringArray ( )
virtual

Getters for time data array candidates.

◆ GetActiveTimeDataArrayName()

virtual char * vtkXMLReader::GetActiveTimeDataArrayName ( )
virtual

Setter / Getter on ActiveTimeDataArrayName.

This string holds the selected time array name. If set to nullptr, time values are the sequence of positive integers starting at zero. Default value is TimeValue for legacy reasons.

◆ SetActiveTimeDataArrayName()

virtual void vtkXMLReader::SetActiveTimeDataArrayName ( const char *  )
virtual

Setter / Getter on ActiveTimeDataArrayName.

This string holds the selected time array name. If set to nullptr, time values are the sequence of positive integers starting at zero. Default value is TimeValue for legacy reasons.

◆ GetPointArrayName()

const char * vtkXMLReader::GetPointArrayName ( int  index)

Get the name of the point, cell, column or time array with the given index in the input.

◆ GetCellArrayName()

const char * vtkXMLReader::GetCellArrayName ( int  index)

Get the name of the point, cell, column or time array with the given index in the input.

◆ GetColumnArrayName()

const char * vtkXMLReader::GetColumnArrayName ( int  index)

Get the name of the point, cell, column or time array with the given index in the input.

◆ GetPointArrayStatus()

int vtkXMLReader::GetPointArrayStatus ( const char *  name)

Get/Set whether the point, cell, column or time array with the given name is to be read.

◆ GetCellArrayStatus()

int vtkXMLReader::GetCellArrayStatus ( const char *  name)

Get/Set whether the point, cell, column or time array with the given name is to be read.

◆ SetPointArrayStatus()

void vtkXMLReader::SetPointArrayStatus ( const char *  name,
int  status 
)

Get/Set whether the point, cell, column or time array with the given name is to be read.

◆ SetCellArrayStatus()

void vtkXMLReader::SetCellArrayStatus ( const char *  name,
int  status 
)

Get/Set whether the point, cell, column or time array with the given name is to be read.

◆ GetColumnArrayStatus()

int vtkXMLReader::GetColumnArrayStatus ( const char *  name)

Get/Set whether the point, cell, column or time array with the given name is to be read.

◆ SetColumnArrayStatus()

void vtkXMLReader::SetColumnArrayStatus ( const char *  name,
int  status 
)

Get/Set whether the point, cell, column or time array with the given name is to be read.

◆ CopyOutputInformation()

virtual void vtkXMLReader::CopyOutputInformation ( vtkInformation vtkNotUsedoutInfo,
int   vtkNotUsedport 
)
inlinevirtual

Definition at line 177 of file vtkXMLReader.h.

◆ SetTimeStep()

virtual void vtkXMLReader::SetTimeStep ( int  )
virtual

Which TimeStep to read.

◆ GetTimeStep()

virtual int vtkXMLReader::GetTimeStep ( )
virtual

Which TimeStep to read.

◆ GetNumberOfTimeSteps()

virtual int vtkXMLReader::GetNumberOfTimeSteps ( )
virtual

◆ GetTimeStepRange() [1/3]

virtual int * vtkXMLReader::GetTimeStepRange ( )
virtual

Which TimeStepRange to read.

◆ GetTimeStepRange() [2/3]

virtual void vtkXMLReader::GetTimeStepRange ( int &  ,
int &   
)
virtual

Which TimeStepRange to read.

◆ GetTimeStepRange() [3/3]

virtual void vtkXMLReader::GetTimeStepRange ( int  [2])
virtual

Which TimeStepRange to read.

◆ SetTimeStepRange() [1/2]

virtual void vtkXMLReader::SetTimeStepRange ( int  ,
int   
)
virtual

Which TimeStepRange to read.

◆ SetTimeStepRange() [2/2]

void vtkXMLReader::SetTimeStepRange ( int  [2])

Which TimeStepRange to read.

◆ GetXMLParser()

vtkXMLDataParser * vtkXMLReader::GetXMLParser ( )
inline

Returns the internal XML parser.

This can be used to access the XML DOM after RequestInformation() was called.

Definition at line 200 of file vtkXMLReader.h.

◆ ProcessRequest()

vtkTypeBool vtkXMLReader::ProcessRequest ( vtkInformation request,
vtkInformationVector **  inInfo,
vtkInformationVector outInfo 
)
overridevirtual

Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

Upstream requests correspond to information flow from the algorithm's outputs to its inputs. Downstream requests correspond to information flow from the algorithm's inputs to its outputs.

A downstream request is defined by the contents of the request information object. The input to the request is stored in the input information vector passed to ProcessRequest. The results of an downstream request are stored in the output information vector passed to ProcessRequest.

An upstream request is defined by the contents of the request information object. The input to the request is stored in the output information vector passed to ProcessRequest. The results of an upstream request are stored in the input information vector passed to ProcessRequest.

It returns the boolean status of the pipeline (false means failure).

Reimplemented from vtkAlgorithm.

◆ SetReaderErrorObserver()

void vtkXMLReader::SetReaderErrorObserver ( vtkCommand )

Set/get the ErrorObserver for the internal reader This is useful for applications that want to catch error messages.

◆ GetReaderErrorObserver()

virtual vtkCommand * vtkXMLReader::GetReaderErrorObserver ( )
virtual

Set/get the ErrorObserver for the internal reader This is useful for applications that want to catch error messages.

◆ SetParserErrorObserver()

void vtkXMLReader::SetParserErrorObserver ( vtkCommand )

Set/get the ErrorObserver for the internal xml parser This is useful for applications that want to catch error messages.

◆ GetParserErrorObserver()

virtual vtkCommand * vtkXMLReader::GetParserErrorObserver ( )
virtual

Set/get the ErrorObserver for the internal xml parser This is useful for applications that want to catch error messages.

◆ ReadXMLInformation()

virtual int vtkXMLReader::ReadXMLInformation ( )
protectedvirtual

Reimplemented in vtkXMLPDataObjectReader.

◆ ReadXMLData()

virtual void vtkXMLReader::ReadXMLData ( )
protectedvirtual

◆ GetDataSetName()

virtual const char * vtkXMLReader::GetDataSetName ( )
protectedpure virtual

◆ CanReadFileVersion()

virtual int vtkXMLReader::CanReadFileVersion ( int  major,
int  minor 
)
protectedvirtual

◆ SetupEmptyOutput()

virtual void vtkXMLReader::SetupEmptyOutput ( )
protectedpure virtual

◆ SetupOutputInformation()

virtual void vtkXMLReader::SetupOutputInformation ( vtkInformation vtkNotUsedoutInfo)
inlineprotectedvirtual

Definition at line 243 of file vtkXMLReader.h.

◆ SetupOutputData()

virtual void vtkXMLReader::SetupOutputData ( )
protectedvirtual

◆ ReadPrimaryElement()

virtual int vtkXMLReader::ReadPrimaryElement ( vtkXMLDataElement ePrimary)
protectedvirtual

◆ ReadVTKFile()

virtual int vtkXMLReader::ReadVTKFile ( vtkXMLDataElement eVTKFile)
protectedvirtual

Reimplemented in vtkXMLUniformGridAMRReader.

◆ GetLocalDataType()

int vtkXMLReader::GetLocalDataType ( vtkXMLDataElement da,
int  datatype 
)
protected

If the IdType argument is present in the provided XMLDataElement and the provided dataType has the same size with VTK_ID_TYPE on this build of VTK, returns VTK_ID_TYPE.

Returns dataType in any other cases.

◆ CreateArray()

vtkAbstractArray * vtkXMLReader::CreateArray ( vtkXMLDataElement da)
protected

◆ CreateInformationKey()

int vtkXMLReader::CreateInformationKey ( vtkXMLDataElement eInfoKey,
vtkInformation info 
)
protected

◆ ReadInformation()

bool vtkXMLReader::ReadInformation ( vtkXMLDataElement infoRoot,
vtkInformation info 
)
protected

◆ OpenStream()

virtual int vtkXMLReader::OpenStream ( )
protectedvirtual

◆ CloseStream()

virtual void vtkXMLReader::CloseStream ( )
protectedvirtual

◆ OpenVTKFile()

virtual int vtkXMLReader::OpenVTKFile ( )
protectedvirtual

◆ CloseVTKFile()

virtual void vtkXMLReader::CloseVTKFile ( )
protectedvirtual

◆ OpenVTKString()

virtual int vtkXMLReader::OpenVTKString ( )
protectedvirtual

◆ CloseVTKString()

virtual void vtkXMLReader::CloseVTKString ( )
protectedvirtual

◆ CreateXMLParser()

virtual void vtkXMLReader::CreateXMLParser ( )
protectedvirtual

Reimplemented in vtkXMLDataReader.

◆ DestroyXMLParser()

virtual void vtkXMLReader::DestroyXMLParser ( )
protectedvirtual

Reimplemented in vtkXMLDataReader.

◆ SetupCompressor()

void vtkXMLReader::SetupCompressor ( const char *  type)
protected

◆ CanReadFileVersionString()

int vtkXMLReader::CanReadFileVersionString ( const char *  version)
protected

◆ CanReadFileWithDataType()

virtual int vtkXMLReader::CanReadFileWithDataType ( const char *  dsname)
protectedvirtual

This method is used by CanReadFile() to check if the reader can read an XML with the primary element with the given name.

Default implementation compares the name with the text returned by this->GetDataSetName().

Reimplemented in vtkXMLUniformGridAMRReader.

◆ GetFileMajorVersion()

virtual int vtkXMLReader::GetFileMajorVersion ( )
protectedvirtual

◆ GetFileMinorVersion()

virtual int vtkXMLReader::GetFileMinorVersion ( )
protectedvirtual

◆ IntersectExtents()

int vtkXMLReader::IntersectExtents ( int *  extent1,
int *  extent2,
int *  result 
)
protected

◆ Min()

int vtkXMLReader::Min ( int  a,
int  b 
)
protected

◆ Max()

int vtkXMLReader::Max ( int  a,
int  b 
)
protected

◆ ComputePointDimensions()

void vtkXMLReader::ComputePointDimensions ( int *  extent,
int *  dimensions 
)
protected

◆ ComputePointIncrements()

void vtkXMLReader::ComputePointIncrements ( int *  extent,
vtkIdType increments 
)
protected

◆ ComputeCellDimensions()

void vtkXMLReader::ComputeCellDimensions ( int *  extent,
int *  dimensions 
)
protected

◆ ComputeCellIncrements()

void vtkXMLReader::ComputeCellIncrements ( int *  extent,
vtkIdType increments 
)
protected

◆ GetStartTuple()

vtkIdType vtkXMLReader::GetStartTuple ( int *  extent,
vtkIdType increments,
int  i,
int  j,
int  k 
)
protected

◆ ReadAttributeIndices()

void vtkXMLReader::ReadAttributeIndices ( vtkXMLDataElement eDSA,
vtkDataSetAttributes dsa 
)
protected

◆ CreateStringArray()

char ** vtkXMLReader::CreateStringArray ( int  numStrings)
protected

◆ DestroyStringArray()

void vtkXMLReader::DestroyStringArray ( int  numStrings,
char **  strings 
)
protected

◆ ReadArrayValues()

virtual int vtkXMLReader::ReadArrayValues ( vtkXMLDataElement da,
vtkIdType  arrayIndex,
vtkAbstractArray array,
vtkIdType  startIndex,
vtkIdType  numValues,
FieldType  type = OTHER 
)
protectedvirtual

◆ SetDataArraySelections()

void vtkXMLReader::SetDataArraySelections ( vtkXMLDataElement eDSA,
vtkDataArraySelection sel 
)
protected

◆ SetFieldDataInfo()

int vtkXMLReader::SetFieldDataInfo ( vtkXMLDataElement eDSA,
int  association,
vtkIdType  numTuples,
vtkInformationVector *&  infoVector 
)
protected

◆ PointDataArrayIsEnabled()

int vtkXMLReader::PointDataArrayIsEnabled ( vtkXMLDataElement ePDA)
protected

◆ CellDataArrayIsEnabled()

int vtkXMLReader::CellDataArrayIsEnabled ( vtkXMLDataElement eCDA)
protected

◆ SelectionModifiedCallback()

static void vtkXMLReader::SelectionModifiedCallback ( vtkObject caller,
unsigned long  eid,
void *  clientdata,
void *  calldata 
)
staticprotected

◆ SqueezeOutputArrays()

virtual void vtkXMLReader::SqueezeOutputArrays ( vtkDataObject )
inlineprotectedvirtual

Reimplemented in vtkXMLPUnstructuredGridReader.

Definition at line 336 of file vtkXMLReader.h.

◆ MarkIdTypeArrays()

void vtkXMLReader::MarkIdTypeArrays ( vtkXMLDataElement da)
protected

XML files have not consistently saved out adequate meta-data in past to correctly create vtkIdTypeArray for global ids and pedigree ids.

This was fixed in vtk/vtk!4819, but all older files don't recreated vtkIdTypeArray correctly. If global ids or pedigree ids are not of type vtkIdTypeArray VTK does not handle them correctly, resulting in paraview/paraview#20239. This methods "annotates" the XML for arrays that are tagged as global/pedigree ids so they are read properly.

◆ GetProgressRange()

virtual void vtkXMLReader::GetProgressRange ( float *  range)
protectedvirtual

◆ SetProgressRange() [1/2]

virtual void vtkXMLReader::SetProgressRange ( const float  range[2],
int  curStep,
int  numSteps 
)
protectedvirtual

◆ SetProgressRange() [2/2]

virtual void vtkXMLReader::SetProgressRange ( const float  range[2],
int  curStep,
const float *  fractions 
)
protectedvirtual

◆ UpdateProgressDiscrete()

virtual void vtkXMLReader::UpdateProgressDiscrete ( float  progress)
protectedvirtual

◆ RequestData()

virtual int vtkXMLReader::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

Reimplemented in vtkXMLGenericDataObjectReader.

◆ RequestDataObject()

virtual int vtkXMLReader::RequestDataObject ( vtkInformation vtkNotUsedrequest,
vtkInformationVector **  vtkNotUsedinputVector,
vtkInformationVector vtkNotUsedoutputVector 
)
inlineprotectedvirtual

Definition at line 405 of file vtkXMLReader.h.

◆ RequestInformation()

virtual int vtkXMLReader::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

◆ SetNumberOfTimeSteps()

void vtkXMLReader::SetNumberOfTimeSteps ( int  num)
protected

◆ IsTimeStepInArray()

static int vtkXMLReader::IsTimeStepInArray ( int  timestep,
int *  timesteps,
int  length 
)
staticprotected

◆ GetCurrentOutput()

vtkDataObject * vtkXMLReader::GetCurrentOutput ( )
protected

◆ GetCurrentOutputInformation()

vtkInformation * vtkXMLReader::GetCurrentOutputInformation ( )
protected

◆ ConvertGhostLevelsToGhostType()

virtual void vtkXMLReader::ConvertGhostLevelsToGhostType ( FieldType  ,
vtkAbstractArray ,
vtkIdType  ,
vtkIdType   
)
inlineprotectedvirtual

Definition at line 448 of file vtkXMLReader.h.

◆ ReadFieldData()

void vtkXMLReader::ReadFieldData ( )
protected

Member Data Documentation

◆ XMLParser

vtkXMLDataParser* vtkXMLReader::XMLParser
protected

Definition at line 350 of file vtkXMLReader.h.

◆ FieldDataElement

vtkXMLDataElement* vtkXMLReader::FieldDataElement
protected

Definition at line 353 of file vtkXMLReader.h.

◆ FileName

char* vtkXMLReader::FileName
protected

Definition at line 356 of file vtkXMLReader.h.

◆ Stream

istream* vtkXMLReader::Stream
protected

Definition at line 359 of file vtkXMLReader.h.

◆ ReadFromInputString

vtkTypeBool vtkXMLReader::ReadFromInputString
protected

Definition at line 363 of file vtkXMLReader.h.

◆ InputString

std::string vtkXMLReader::InputString
protected

Definition at line 366 of file vtkXMLReader.h.

◆ PointDataArraySelection

vtkDataArraySelection* vtkXMLReader::PointDataArraySelection
protected

Definition at line 369 of file vtkXMLReader.h.

◆ CellDataArraySelection

vtkDataArraySelection* vtkXMLReader::CellDataArraySelection
protected

Definition at line 370 of file vtkXMLReader.h.

◆ ColumnArraySelection

vtkDataArraySelection* vtkXMLReader::ColumnArraySelection
protected

Definition at line 371 of file vtkXMLReader.h.

◆ TimeDataStringArray

vtkStringArray* vtkXMLReader::TimeDataStringArray
protected

Definition at line 372 of file vtkXMLReader.h.

◆ ActiveTimeDataArrayName

char* vtkXMLReader::ActiveTimeDataArrayName
protected

Name of the field-data array used to determine the time for the dataset being read.

Definition at line 378 of file vtkXMLReader.h.

◆ TimeDataArray

vtkSmartPointer<vtkDataArray> vtkXMLReader::TimeDataArray
protected

Populated in ReadXMLInformation from the field data for the array chosen using ActiveTimeDataArrayName, if any.

nullptr otherwise.

Definition at line 384 of file vtkXMLReader.h.

◆ SelectionObserver

vtkCallbackCommand* vtkXMLReader::SelectionObserver
protected

Definition at line 388 of file vtkXMLReader.h.

◆ InformationError

int vtkXMLReader::InformationError
protected

Definition at line 391 of file vtkXMLReader.h.

◆ DataError

int vtkXMLReader::DataError
protected

Definition at line 394 of file vtkXMLReader.h.

◆ ProgressRange

float vtkXMLReader::ProgressRange[2]
protected

Definition at line 401 of file vtkXMLReader.h.

◆ ReadMTime

vtkTimeStamp vtkXMLReader::ReadMTime
protected

Definition at line 412 of file vtkXMLReader.h.

◆ ReadError

int vtkXMLReader::ReadError
protected

Definition at line 415 of file vtkXMLReader.h.

◆ AxesEmpty

int vtkXMLReader::AxesEmpty[3]
protected

Definition at line 420 of file vtkXMLReader.h.

◆ TimeStep

int vtkXMLReader::TimeStep
protected

Definition at line 423 of file vtkXMLReader.h.

◆ CurrentTimeStep

int vtkXMLReader::CurrentTimeStep
protected

Definition at line 424 of file vtkXMLReader.h.

◆ NumberOfTimeSteps

int vtkXMLReader::NumberOfTimeSteps
protected

Definition at line 425 of file vtkXMLReader.h.

◆ TimeSteps

int* vtkXMLReader::TimeSteps
protected

Definition at line 429 of file vtkXMLReader.h.

◆ TimeStepRange

int vtkXMLReader::TimeStepRange[2]
protected

Definition at line 431 of file vtkXMLReader.h.

◆ InReadData

int vtkXMLReader::InReadData
protected

Definition at line 446 of file vtkXMLReader.h.


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