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

#include <vtkXMLReader.h>

Inheritance diagram for vtkXMLReader:

Collaboration diagram for vtkXMLReader:

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.

vtkXMLReader *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual int	CanReadFile (VTK_FILEPATH const char *name)
	Test whether the file (type) with the given name can be read by this reader.

virtual void	CopyOutputInformation (vtkInformation *vtkNotUsed(outInfo), int vtkNotUsed(port))

virtual int	GetNumberOfTimeSteps ()

vtkXMLDataParser *	GetXMLParser ()
	Returns the internal XML parser.

vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.


	vtkSetFilePathMacro (FileName)
	Get/Set the name of the input file.

	vtkGetFilePathMacro (FileName)
	Get/Set the name of the input file.


virtual void	SetReadFromInputString (vtkTypeBool)
	Enable reading from an InputString instead of the default, a file.

virtual vtkTypeBool	GetReadFromInputString ()
	Enable reading from an InputString instead of the default, a file.

virtual void	ReadFromInputStringOn ()
	Enable reading from an InputString instead of the default, a file.

virtual void	ReadFromInputStringOff ()
	Enable reading from an InputString instead of the default, a file.

void	SetInputString (const std::string &s)
	Enable reading from an InputString instead of the default, a file.


vtkDataSet *	GetOutputAsDataSet ()
	Get the output as a vtkDataSet pointer.

vtkDataSet *	GetOutputAsDataSet (int index)
	Get the output as a vtkDataSet pointer.


virtual vtkDataArraySelection *	GetPointDataArraySelection ()
	Get the data array selection tables used to configure which data arrays are loaded by the reader.

virtual vtkDataArraySelection *	GetCellDataArraySelection ()
	Get the data array selection tables used to configure which data arrays are loaded by the reader.

virtual vtkDataArraySelection *	GetColumnArraySelection ()
	Get the data array selection tables used to configure which data arrays are loaded by the reader.


int	GetNumberOfPointArrays ()
	Get the number of point, cell or column arrays available in the input.

int	GetNumberOfCellArrays ()
	Get the number of point, cell or column arrays available in the input.

int	GetNumberOfColumnArrays ()
	Get the number of point, cell or column arrays available in the input.


int	GetNumberOfTimeDataArrays () const
	Getters for time data array candidates.

const char *	GetTimeDataArray (int idx) const
	Getters for time data array candidates.

virtual vtkStringArray *	GetTimeDataStringArray ()
	Getters for time data array candidates.


virtual char *	GetActiveTimeDataArrayName ()
	Setter / Getter on ActiveTimeDataArrayName.

virtual void	SetActiveTimeDataArrayName (const char *)
	Setter / Getter on ActiveTimeDataArrayName.


const char *	GetPointArrayName (int index)
	Get the name of the point, cell, column or time array with the given index in the input.

const char *	GetCellArrayName (int index)
	Get the name of the point, cell, column or time array with the given index in the input.

const char *	GetColumnArrayName (int index)
	Get the name of the point, cell, column or time array with the given index in the input.


int	GetPointArrayStatus (const char *name)
	Get/Set whether the point, cell, column or time array with the given name is to be read.

int	GetCellArrayStatus (const char *name)
	Get/Set whether the point, cell, column or time array with the given name is to be read.

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.

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.

int	GetColumnArrayStatus (const char *name)
	Get/Set whether the point, cell, column or time array with the given name is to be read.

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.


virtual void	SetTimeStep (int)
	Which TimeStep to read.

virtual int	GetTimeStep ()
	Which TimeStep to read.


virtual int *	GetTimeStepRange ()
	Which TimeStepRange to read.

virtual void	GetTimeStepRange (int &, int &)
	Which TimeStepRange to read.

virtual void	GetTimeStepRange (int[2])
	Which TimeStepRange to read.

virtual void	SetTimeStepRange (int, int)
	Which TimeStepRange to read.

void	SetTimeStepRange (int[2])
	Which TimeStepRange to read.


void	SetReaderErrorObserver (vtkCommand *)
	Set/get the ErrorObserver for the internal reader This is useful for applications that want to catch error messages.

virtual vtkCommand *	GetReaderErrorObserver ()
	Set/get the ErrorObserver for the internal reader This is useful for applications that want to catch error messages.


void	SetParserErrorObserver (vtkCommand *)
	Set/get the ErrorObserver for the internal xml parser This is useful for applications that want to catch error messages.

virtual vtkCommand *	GetParserErrorObserver ()
	Set/get the ErrorObserver for the internal xml parser This is useful for applications that want to catch error messages.

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.

vtkAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

int	HasExecutive ()
	Check whether this algorithm has an assigned executive.

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.

virtual vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

vtkTypeBool	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.

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.

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.

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.

void	SetProgress (double)
	`SetProgress` is deprecated.

void	UpdateProgress (double amount)
	Update the progress of the process object.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	String based versions of SetInputArrayToProcess().

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.

void	RemoveAllInputs ()
	Remove all the input data.

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.

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

virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.

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.

virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.

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.

virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date.

virtual void	UpdateDataObject ()
	Create output object(s).

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.

virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.

void	Register (vtkObjectBase *o) override
	Participate in garbage collection.

void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection.

virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.

virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.

virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.

virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.

virtual double	GetProgress ()
	Get the execution progress of a process object.

void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.

virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date.

virtual void	Update ()
	Bring this algorithm's outputs up-to-date.

virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports.

virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.

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.

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.

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.

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.

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.

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

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.

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.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

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

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkXMLReader *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

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

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () 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.

vtkAbstractArray *	CreateArray (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.

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.

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)

vtkDataObject *	GetCurrentOutput ()

vtkInformation *	GetCurrentOutputInformation ()

virtual void	ConvertGhostLevelsToGhostType (FieldType, vtkAbstractArray *, vtkIdType, vtkIdType)

void	ReadFieldData ()

Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAlgorithm ()

	~vtkAlgorithm () override

virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.

virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.

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.

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.

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.

int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (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.

vtkDataArray *	GetInputArrayToProcess (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.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (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.

vtkAbstractArray *	GetInputAbstractArrayToProcess (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.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.

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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

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 vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
vtkXMLDataParser *	XMLParser

vtkXMLDataElement *	FieldDataElement

char *	FileName

istream *	Stream

vtkTypeBool	ReadFromInputString

std::string	InputString

vtkDataArraySelection *	PointDataArraySelection

vtkDataArraySelection *	CellDataArraySelection

vtkDataArraySelection *	ColumnArraySelection

vtkStringArray *	TimeDataStringArray

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

vtkSmartPointer< vtkDataArray >	TimeDataArray
	Populated in `ReadXMLInformation` from the field data for the array chosen using ActiveTimeDataArrayName, if any.

vtkCallbackCommand *	SelectionObserver

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
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.

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 vtkExecutive *	DefaultExecutivePrototype

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:

DumpXMLFile

Definition at line 65 of file vtkXMLReader.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAlgorithm vtkXMLReader::Superclass

Definition at line 68 of file vtkXMLReader.h.

Member Enumeration Documentation

◆ FieldType

enum vtkXMLReader::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

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

Reimplemented in vtkPhyloXMLTreeReader, vtkRTXMLPolyDataReader, vtkXMLCompositeDataReader, vtkXMLDataReader, vtkXMLGenericDataObjectReader, vtkXMLHierarchicalBoxDataReader, vtkXMLHierarchicalDataReader, vtkXMLHyperTreeGridReader, vtkXMLImageDataReader, vtkXMLMultiBlockDataReader, vtkXMLMultiGroupDataReader, vtkXMLPartitionedDataSetCollectionReader, vtkXMLPartitionedDataSetReader, vtkXMLPDataObjectReader, vtkXMLPDataReader, vtkXMLPHyperTreeGridReader, vtkXMLPImageDataReader, vtkXMLPolyDataReader, vtkXMLPPolyDataReader, vtkXMLPRectilinearGridReader, vtkXMLPStructuredDataReader, vtkXMLPStructuredGridReader, vtkXMLPTableReader, vtkXMLPUnstructuredDataReader, vtkXMLPUnstructuredGridReader, vtkXMLRectilinearGridReader, vtkXMLStructuredDataReader, vtkXMLStructuredGridReader, vtkXMLTableReader, vtkXMLUniformGridAMRReader, vtkXMLUnstructuredDataReader, and vtkXMLUnstructuredGridReader.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkXMLReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAlgorithm.

Reimplemented in vtkPhyloXMLTreeReader, vtkRTXMLPolyDataReader, vtkXMLCompositeDataReader, vtkXMLDataReader, vtkXMLGenericDataObjectReader, vtkXMLHierarchicalBoxDataReader, vtkXMLHierarchicalDataReader, vtkXMLHyperTreeGridReader, vtkXMLImageDataReader, vtkXMLMultiBlockDataReader, vtkXMLMultiGroupDataReader, vtkXMLPartitionedDataSetCollectionReader, vtkXMLPartitionedDataSetReader, vtkXMLPDataObjectReader, vtkXMLPDataReader, vtkXMLPHyperTreeGridReader, vtkXMLPImageDataReader, vtkXMLPolyDataReader, vtkXMLPPolyDataReader, vtkXMLPRectilinearGridReader, vtkXMLPStructuredDataReader, vtkXMLPStructuredGridReader, vtkXMLPTableReader, vtkXMLPUnstructuredDataReader, vtkXMLPUnstructuredGridReader, vtkXMLRectilinearGridReader, vtkXMLStructuredDataReader, vtkXMLStructuredGridReader, vtkXMLTableReader, vtkXMLUniformGridAMRReader, vtkXMLUnstructuredDataReader, and vtkXMLUnstructuredGridReader.

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