Reads eXtensible Data Model and Format files. More...

#include <vtkXdmfReader.h>

Inheritance diagram for vtkXdmfReader:

Collaboration diagram for vtkXdmfReader:

Classes
class	XdmfDataSetTopoGeoPath

Public Types
typedef vtkDataObjectAlgorithm	Superclass

typedef std::map< int, XdmfDataSetTopoGeoPath >	XdmfReaderCachedData

Public Types inherited from vtkDataObjectAlgorithm
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.

vtkXdmfReader *	NewInstance () const

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

int	GetNumberOfPointArrays ()
	Get information about point-based arrays.

const char *	GetPointArrayName (int index)
	Returns the name of point array at the give index.

virtual int	CanReadFile (VTK_FILEPATH const char *filename)
	Determine if the file can be read with this reader.

virtual vtkGraph *	GetSIL ()
	SIL describes organization of/relationships between classifications eg.

XdmfReaderCachedData &	GetDataSetCache ()
	Get the data set cache.


virtual void	SetDomainName (const char *)
	Set the active domain.

virtual char *	GetDomainName ()
	Set the active domain.


	vtkSetFilePathMacro (FileName)
	Name of the file to read.

	vtkGetFilePathMacro (FileName)
	Name of the file to read.


int	GetPointArrayStatus (const char *name)
	Get/Set the point array status.

void	SetPointArrayStatus (const char *name, int status)
	Get/Set the point array status.


int	GetNumberOfCellArrays ()
	Get information about cell-based arrays.

const char *	GetCellArrayName (int index)
	Get information about cell-based arrays.

void	SetCellArrayStatus (const char *name, int status)
	Get information about cell-based arrays.

int	GetCellArrayStatus (const char *name)
	Get information about cell-based arrays.


int	GetNumberOfGrids ()
	Get/Set information about grids.

const char *	GetGridName (int index)
	Get/Set information about grids.

void	SetGridStatus (const char *gridname, int status)
	Get/Set information about grids.

int	GetGridStatus (const char *gridname)
	Get/Set information about grids.


int	GetNumberOfSets ()
	Get/Set information about sets.

const char *	GetSetName (int index)
	Get/Set information about sets.

void	SetSetStatus (const char *gridname, int status)
	Get/Set information about sets.

int	GetSetStatus (const char *gridname)
	Get/Set information about sets.


int	GetNumberOfSetArrays ()
	These methods are provided to make it easier to use the Sets/Grids in ParaView.

const char *	GetSetArrayName (int index)
	These methods are provided to make it easier to use the Sets/Grids in ParaView.

int	GetSetArrayStatus (const char *name)
	These methods are provided to make it easier to use the Sets/Grids in ParaView.

int	GetNumberOfGridArrays ()
	These methods are provided to make it easier to use the Sets/Grids in ParaView.

const char *	GetGridArrayName (int index)
	These methods are provided to make it easier to use the Sets/Grids in ParaView.

int	GetGridArrayStatus (const char *name)
	These methods are provided to make it easier to use the Sets/Grids in ParaView.


virtual void	SetStride (int, int, int)
	Get/Set the stride used to skip points when reading structured datasets.

virtual void	SetStride (int[3])
	Get/Set the stride used to skip points when reading structured datasets.

virtual int *	GetStride ()
	Get/Set the stride used to skip points when reading structured datasets.

virtual void	GetStride (int &, int &, int &)
	Get/Set the stride used to skip points when reading structured datasets.

virtual void	GetStride (int[3])
	Get/Set the stride used to skip points when reading structured datasets.


virtual int	GetSILUpdateStamp ()
	Every time the SIL is updated a this will return a different value.


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

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

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

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


virtual void	SetInputArray (vtkCharArray *)
	Specify the vtkCharArray to be used when reading from a string.

virtual vtkCharArray *	GetInputArray ()
	Specify the vtkCharArray to be used when reading from a string.


void	SetInputString (const char *in)
	Specify the InputString for use when reading from a character array.

virtual char *	GetInputString ()
	Specify the InputString for use when reading from a character array.

void	SetInputString (const char *in, int len)
	Specify the InputString for use when reading from a character array.

virtual int	GetInputStringLength ()
	Specify the InputString for use when reading from a character array.

void	SetBinaryInputString (const char *, int len)
	Specify the InputString for use when reading from a character array.

void	SetInputString (const std::string &input)
	Specify the InputString for use when reading from a character array.

Public Member Functions inherited from vtkDataObjectAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkDataObjectAlgorithm *	NewInstance () const

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

vtkTypeBool	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	see vtkAlgorithm for details

vtkDataObject *	GetInput ()

vtkDataObject *	GetInput (int port)

vtkDataObject *	GetOutput ()
	Get the output data object for a port on this algorithm.

vtkDataObject *	GetOutput (int)
	Get the output data object for a port on this algorithm.

virtual void	SetOutput (vtkDataObject *d)
	Get the output data object for a port on this algorithm.

void	SetInputData (vtkDataObject *)
	Assign a data object as input.

void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.

void	AddInputData (vtkDataObject *)
	Assign a data object as input.

void	AddInputData (int, vtkDataObject *)
	Assign a data object as input.

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 vtkXdmfReader *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkXdmfReader *	SafeDownCast (vtkObjectBase *o)

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataObjectAlgorithm *	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

	vtkXdmfReader ()

	~vtkXdmfReader () override

vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	see vtkAlgorithm for details

virtual int	RequestDataObjectInternal (vtkInformationVector *outputVector)

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector ) override

int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector ) override

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

vtkXdmfArraySelection *	GetPointArraySelection ()

vtkXdmfArraySelection *	GetCellArraySelection ()

vtkXdmfArraySelection *	GetGridSelection ()

vtkXdmfArraySelection *	GetSetsSelection ()

void	PassCachedSelections ()

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

	vtkDataObjectAlgorithm ()

	~vtkDataObjectAlgorithm () override

virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	RequestDataObject (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass.

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass.

virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )

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

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

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

Protected Attributes
char *	FileName

bool	ReadFromInputString

vtkCharArray *	InputArray

char *	InputString

int	InputStringLength

int	InputStringPos

char *	DomainName

int	Stride [3]

unsigned int	LastTimeIndex

vtkXdmfDocument *	XdmfDocument

vtkXdmfArraySelection *	PointArraysCache

vtkXdmfArraySelection *	CellArraysCache

vtkXdmfArraySelection *	GridsCache

vtkXdmfArraySelection *	SetsCache

int	SILUpdateStamp

XdmfReaderCachedData	DataSetCache

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 Member Functions inherited from vtkDataObjectAlgorithm
static bool	SetOutputDataObject (int dataType, vtkInformation *outputInformation, bool exact=false)
	A helper method that can be used by subclasses in `RequestDataObject` to create an output data object of the given type if not already present.

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

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Reads eXtensible Data Model and Format files.

vtkXdmfReader reads XDMF data files so that they can be visualized using VTK. The output data produced by this reader depends on the number of grids in the data file. If the data file has a single domain with a single grid, then the output type is a vtkDataSet subclass of the appropriate type, otherwise it's a vtkMultiBlockDataSet.

Refer to vtkDataReader which provides many methods for controlling the reading of the data file.

Warning: Uses the XDMF API (http://www.xdmf.org)

See also: vtkDataReader

Definition at line 47 of file vtkXdmfReader.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataObjectAlgorithm vtkXdmfReader::Superclass

Definition at line 51 of file vtkXdmfReader.h.

◆ XdmfReaderCachedData

typedef std::map<int, XdmfDataSetTopoGeoPath> vtkXdmfReader::XdmfReaderCachedData

Definition at line 197 of file vtkXdmfReader.h.

Constructor & Destructor Documentation

◆ vtkXdmfReader()

vtkXdmfReader::vtkXdmfReader ( )

protected

◆ ~vtkXdmfReader()

vtkXdmfReader::~vtkXdmfReader ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkXdmfReader * vtkXdmfReader::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkXdmfReader::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 vtkDataObjectAlgorithm.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkXdmfReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ NewInstance()

vtkXdmfReader * vtkXdmfReader::NewInstance ( ) const

◆ PrintSelf()

void vtkXdmfReader::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 vtkDataObjectAlgorithm.

◆ SetDomainName()

virtual void vtkXdmfReader::SetDomainName ( const char * )

virtual

Set the active domain.

Only one domain can be selected at a time. By default the first domain in the datafile is chosen. Setting this to null results in the domain being automatically chosen. Note that if the domain name is changed, you should explicitly call UpdateInformation() before accessing information about grids, data arrays etc.

◆ GetDomainName()

virtual char * vtkXdmfReader::GetDomainName ( )

virtual

Set the active domain.

Only one domain can be selected at a time. By default the first domain in the datafile is chosen. Setting this to null results in the domain being automatically chosen. Note that if the domain name is changed, you should explicitly call UpdateInformation() before accessing information about grids, data arrays etc.

◆ vtkSetFilePathMacro()

vtkXdmfReader::vtkSetFilePathMacro ( FileName )

Name of the file to read.

◆ vtkGetFilePathMacro()

vtkXdmfReader::vtkGetFilePathMacro ( FileName )

Name of the file to read.

◆ GetNumberOfPointArrays()

int vtkXdmfReader::GetNumberOfPointArrays ( )

Get information about point-based arrays.

As is typical with readers this in only valid after the filename is set and UpdateInformation() has been called.

◆ GetPointArrayName()

const char * vtkXdmfReader::GetPointArrayName ( int index )

Returns the name of point array at the give index.

Returns nullptr if index is invalid.

◆ GetPointArrayStatus()

int vtkXdmfReader::GetPointArrayStatus ( const char * name )

Get/Set the point array status.

◆ SetPointArrayStatus()

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

Get/Set the point array status.

◆ GetNumberOfCellArrays()

int vtkXdmfReader::GetNumberOfCellArrays ( )

Get information about cell-based arrays.

As is typical with readers this in only valid after the filename is set and UpdateInformation() has been called.

◆ GetCellArrayName()

const char * vtkXdmfReader::GetCellArrayName ( int index )

Get information about cell-based arrays.

As is typical with readers this in only valid after the filename is set and UpdateInformation() has been called.

◆ SetCellArrayStatus()

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

Get information about cell-based arrays.

As is typical with readers this in only valid after the filename is set and UpdateInformation() has been called.

◆ GetCellArrayStatus()

int vtkXdmfReader::GetCellArrayStatus ( const char * name )

Get information about cell-based arrays.

As is typical with readers this in only valid after the filename is set and UpdateInformation() has been called.

◆ GetNumberOfGrids()

int vtkXdmfReader::GetNumberOfGrids ( )

Get/Set information about grids.

As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called.

◆ GetGridName()

const char * vtkXdmfReader::GetGridName ( int index )

Get/Set information about grids.

As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called.

◆ SetGridStatus()

void vtkXdmfReader::SetGridStatus	(	const char *	gridname,
		int	status
	)

Get/Set information about grids.

As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called.

◆ GetGridStatus()

int vtkXdmfReader::GetGridStatus ( const char * gridname )

Get/Set information about grids.

As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called.

◆ GetNumberOfSets()

int vtkXdmfReader::GetNumberOfSets ( )

Get/Set information about sets.

As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called. Note that sets with non-zero Ghost value are not treated as sets that the user can select using this API.

◆ GetSetName()

const char * vtkXdmfReader::GetSetName ( int index )

Get/Set information about sets.

As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called. Note that sets with non-zero Ghost value are not treated as sets that the user can select using this API.

◆ SetSetStatus()

void vtkXdmfReader::SetSetStatus	(	const char *	gridname,
		int	status
	)

Get/Set information about sets.

As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called. Note that sets with non-zero Ghost value are not treated as sets that the user can select using this API.

◆ GetSetStatus()

int vtkXdmfReader::GetSetStatus ( const char * gridname )

Get/Set information about sets.

As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called. Note that sets with non-zero Ghost value are not treated as sets that the user can select using this API.

◆ GetNumberOfSetArrays()

int vtkXdmfReader::GetNumberOfSetArrays ( )

inline

These methods are provided to make it easier to use the Sets/Grids in ParaView.

Definition at line 148 of file vtkXdmfReader.h.

◆ GetSetArrayName()

const char * vtkXdmfReader::GetSetArrayName ( int index )

inline

These methods are provided to make it easier to use the Sets/Grids in ParaView.

Definition at line 149 of file vtkXdmfReader.h.

◆ GetSetArrayStatus()

int vtkXdmfReader::GetSetArrayStatus ( const char * name )

inline

These methods are provided to make it easier to use the Sets/Grids in ParaView.

Definition at line 150 of file vtkXdmfReader.h.

◆ GetNumberOfGridArrays()

int vtkXdmfReader::GetNumberOfGridArrays ( )

inline

These methods are provided to make it easier to use the Sets/Grids in ParaView.

Definition at line 151 of file vtkXdmfReader.h.

◆ GetGridArrayName()

const char * vtkXdmfReader::GetGridArrayName ( int index )

inline

These methods are provided to make it easier to use the Sets/Grids in ParaView.

Definition at line 152 of file vtkXdmfReader.h.

◆ GetGridArrayStatus()

int vtkXdmfReader::GetGridArrayStatus ( const char * name )

inline

These methods are provided to make it easier to use the Sets/Grids in ParaView.

Definition at line 153 of file vtkXdmfReader.h.

◆ SetStride() [1/2]

virtual void vtkXdmfReader::SetStride	(	int	,
		int	,
		int
	)

virtual

Get/Set the stride used to skip points when reading structured datasets.

This affects all grids being read.

◆ SetStride() [2/2]

virtual void vtkXdmfReader::SetStride ( int [3] )

virtual

Get/Set the stride used to skip points when reading structured datasets.

This affects all grids being read.

◆ GetStride() [1/3]

virtual int * vtkXdmfReader::GetStride ( )

virtual

Get/Set the stride used to skip points when reading structured datasets.

This affects all grids being read.

◆ GetStride() [2/3]

virtual void vtkXdmfReader::GetStride	(	int &	,
		int &	,
		int &
	)

virtual

Get/Set the stride used to skip points when reading structured datasets.

This affects all grids being read.

◆ GetStride() [3/3]

virtual void vtkXdmfReader::GetStride ( int [3] )

virtual

Get/Set the stride used to skip points when reading structured datasets.

This affects all grids being read.

◆ CanReadFile()

virtual int vtkXdmfReader::CanReadFile ( VTK_FILEPATH const char * filename )

virtual

Determine if the file can be read with this reader.

◆ GetSILUpdateStamp()

virtual int vtkXdmfReader::GetSILUpdateStamp ( )

virtual

Every time the SIL is updated a this will return a different value.

◆ GetSIL()

virtual vtkGraph * vtkXdmfReader::GetSIL ( )

virtual

SIL describes organization of/relationships between classifications eg.

blocks/materials/hierarchies.

◆ GetDataSetCache()

XdmfReaderCachedData & vtkXdmfReader::GetDataSetCache ( )

Get the data set cache.

◆ SetReadFromInputString()

virtual void vtkXdmfReader::SetReadFromInputString ( bool )

virtual

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

◆ GetReadFromInputString()

virtual bool vtkXdmfReader::GetReadFromInputString ( )

virtual

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

◆ ReadFromInputStringOn()

virtual void vtkXdmfReader::ReadFromInputStringOn ( )

virtual

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

◆ ReadFromInputStringOff()

virtual void vtkXdmfReader::ReadFromInputStringOff ( )

virtual

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

◆ SetInputArray()

virtual void vtkXdmfReader::SetInputArray ( vtkCharArray * )

virtual

Specify the vtkCharArray to be used when reading from a string.

If set, this array has precedence over InputString. Use this instead of InputString to avoid the extra memory copy. It should be noted that if the underlying char* is owned by the user ( vtkCharArray::SetArray(array, 1); ) and is deleted before the reader, bad things will happen during a pipeline update.

◆ GetInputArray()

virtual vtkCharArray * vtkXdmfReader::GetInputArray ( )

virtual

Specify the vtkCharArray to be used when reading from a string.

If set, this array has precedence over InputString. Use this instead of InputString to avoid the extra memory copy. It should be noted that if the underlying char* is owned by the user ( vtkCharArray::SetArray(array, 1); ) and is deleted before the reader, bad things will happen during a pipeline update.