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

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

#include <vtkXdmfReader.h>

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

Classes

class  XdmfDataSetTopoGeoPath
 

Public Types

typedef vtkDataObjectAlgorithm Superclass
 
typedef std::map< int, XdmfDataSetTopoGeoPathXdmfReaderCachedData
 
- 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. More...
 
vtkXdmfReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int GetNumberOfPointArrays ()
 Get information about point-based arrays. More...
 
const char * GetPointArrayName (int index)
 Returns the name of point array at the give index. More...
 
int GetNumberOfSetArrays ()
 These methods are provided to make it easier to use the Sets in ParaView. More...
 
const char * GetSetArrayName (int index)
 
int GetSetArrayStatus (const char *name)
 
virtual int CanReadFile (const char *filename)
 Determine if the file can be read with this reader. More...
 
virtual vtkGraphGetSIL ()
 SIL describes organization of/relationships between classifications eg. More...
 
XdmfReaderCachedDataGetDataSetCache ()
 Get the data set cache. More...
 
virtual void SetDomainName (const char *)
 Set the active domain. More...
 
virtual char * GetDomainName ()
 Set the active domain. More...
 
virtual void SetFileName (const char *)
 Name of the file to read. More...
 
virtual char * GetFileName ()
 Name of the file to read. More...
 
int GetPointArrayStatus (const char *name)
 Get/Set the point array status. More...
 
void SetPointArrayStatus (const char *name, int status)
 Get/Set the point array status. More...
 
int GetNumberOfCellArrays ()
 Get information about cell-based arrays. More...
 
const char * GetCellArrayName (int index)
 Get information about cell-based arrays. More...
 
void SetCellArrayStatus (const char *name, int status)
 Get information about cell-based arrays. More...
 
int GetCellArrayStatus (const char *name)
 Get information about cell-based arrays. More...
 
int GetNumberOfGrids ()
 Get/Set information about grids. More...
 
const char * GetGridName (int index)
 Get/Set information about grids. More...
 
void SetGridStatus (const char *gridname, int status)
 Get/Set information about grids. More...
 
int GetGridStatus (const char *gridname)
 Get/Set information about grids. More...
 
int GetNumberOfSets ()
 Get/Set information about sets. More...
 
const char * GetSetName (int index)
 Get/Set information about sets. More...
 
void SetSetStatus (const char *gridname, int status)
 Get/Set information about sets. More...
 
int GetSetStatus (const char *gridname)
 Get/Set information about sets. More...
 
virtual void SetStride (int, int, int)
 Get/Set the stride used to skip points when reading structured datasets. More...
 
virtual void SetStride (int[3])
 Get/Set the stride used to skip points when reading structured datasets. More...
 
virtual intGetStride ()
 Get/Set the stride used to skip points when reading structured datasets. More...
 
virtual void GetStride (int &, int &, int &)
 Get/Set the stride used to skip points when reading structured datasets. More...
 
virtual void GetStride (int[3])
 Get/Set the stride used to skip points when reading structured datasets. More...
 
virtual int GetSILUpdateStamp ()
 Every time the SIL is updated a this will return a different value. More...
 
virtual void SetReadFromInputString (bool)
 Enable reading from an InputString or InputArray instead of the default, a file. More...
 
virtual bool GetReadFromInputString ()
 Enable reading from an InputString or InputArray instead of the default, a file. More...
 
virtual void ReadFromInputStringOn ()
 Enable reading from an InputString or InputArray instead of the default, a file. More...
 
virtual void ReadFromInputStringOff ()
 Enable reading from an InputString or InputArray instead of the default, a file. More...
 
virtual void SetInputArray (vtkCharArray *)
 Specify the vtkCharArray to be used when reading from a string. More...
 
virtual vtkCharArrayGetInputArray ()
 Specify the vtkCharArray to be used when reading from a string. More...
 
void SetInputString (const char *in)
 Specify the InputString for use when reading from a character array. More...
 
virtual char * GetInputString ()
 Specify the InputString for use when reading from a character array. More...
 
void SetInputString (const char *in, int len)
 Specify the InputString for use when reading from a character array. More...
 
virtual int GetInputStringLength ()
 Specify the InputString for use when reading from a character array. More...
 
void SetBinaryInputString (const char *, int len)
 Specify the InputString for use when reading from a character array. More...
 
void SetInputString (const std::string &input)
 Specify the InputString for use when reading from a character array. More...
 
- Public Member Functions inherited from vtkDataObjectAlgorithm
vtkDataObjectAlgorithmNewInstance () const
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkDataObjectGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkDataObjectGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
virtual void SetOutput (vtkDataObject *d)
 Get the output data object for a port on this algorithm. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual int Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual int Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkXdmfReaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXdmfReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkDataObjectAlgorithm
static vtkDataObjectAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataObjectAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

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

Protected Attributes

char * FileName
 
bool ReadFromInputString
 
vtkCharArrayInputArray
 
char * InputString
 
int InputStringLength
 
int InputStringPos
 
char * DomainName
 
int Stride [3]
 
unsigned int LastTimeIndex
 
vtkXdmfDocumentXdmfDocument
 
vtkXdmfArraySelectionPointArraysCache
 
vtkXdmfArraySelectionCellArraysCache
 
vtkXdmfArraySelectionGridsCache
 
vtkXdmfArraySelectionSetsCache
 
int SILUpdateStamp
 
XdmfReaderCachedData DataSetCache
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

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

Detailed Description

Reads 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
Tests:
vtkXdmfReader (Tests)

Definition at line 50 of file vtkXdmfReader.h.

Member Typedef Documentation

Definition at line 54 of file vtkXdmfReader.h.

Definition at line 192 of file vtkXdmfReader.h.

Constructor & Destructor Documentation

vtkXdmfReader::vtkXdmfReader ( )
protected
vtkXdmfReader::~vtkXdmfReader ( )
overrideprotected

Member Function Documentation

static vtkXdmfReader* vtkXdmfReader::New ( )
static
static vtkTypeBool vtkXdmfReader::IsTypeOf ( const char *  type)
static
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.

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

Reimplemented from vtkDataObjectAlgorithm.

vtkXdmfReader* vtkXdmfReader::NewInstance ( ) const
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.

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.

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.

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

Name of the file to read.

virtual char* vtkXdmfReader::GetFileName ( )
virtual

Name of the file to read.

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.

const char* vtkXdmfReader::GetPointArrayName ( int  index)

Returns the name of point array at the give index.

Returns nullptr if index is invalid.

int vtkXdmfReader::GetPointArrayStatus ( const char *  name)

Get/Set the point array status.

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

Get/Set the point array status.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

int vtkXdmfReader::GetNumberOfSetArrays ( )
inline

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

Definition at line 150 of file vtkXdmfReader.h.

const char* vtkXdmfReader::GetSetArrayName ( int  index)
inline

Definition at line 151 of file vtkXdmfReader.h.

int vtkXdmfReader::GetSetArrayStatus ( const char *  name)
inline

Definition at line 153 of file vtkXdmfReader.h.

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.

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.

virtual int* vtkXdmfReader::GetStride ( )
virtual

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

This affects all grids being read.

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.

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.

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

Determine if the file can be read with this reader.

virtual int vtkXdmfReader::GetSILUpdateStamp ( )
virtual

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

virtual vtkGraph* vtkXdmfReader::GetSIL ( )
virtual

SIL describes organization of/relationships between classifications eg.

blocks/materials/hierarchies.

XdmfReaderCachedData& vtkXdmfReader::GetDataSetCache ( )

Get the data set cache.

virtual void vtkXdmfReader::SetReadFromInputString ( bool  )
virtual

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

virtual bool vtkXdmfReader::GetReadFromInputString ( )
virtual

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

virtual void vtkXdmfReader::ReadFromInputStringOn ( )
virtual

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

virtual void vtkXdmfReader::ReadFromInputStringOff ( )
virtual

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

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.

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.

void vtkXdmfReader::SetInputString ( const char *  in)

Specify the InputString for use when reading from a character array.

Optionally include the length for binary strings. Note that a copy of the string is made and stored. If this causes exceedingly large memory consumption, consider using InputArray instead.

virtual char* vtkXdmfReader::GetInputString ( )
virtual

Specify the InputString for use when reading from a character array.

Optionally include the length for binary strings. Note that a copy of the string is made and stored. If this causes exceedingly large memory consumption, consider using InputArray instead.

void vtkXdmfReader::SetInputString ( const char *  in,
int  len 
)

Specify the InputString for use when reading from a character array.

Optionally include the length for binary strings. Note that a copy of the string is made and stored. If this causes exceedingly large memory consumption, consider using InputArray instead.

virtual int vtkXdmfReader::GetInputStringLength ( )
virtual

Specify the InputString for use when reading from a character array.

Optionally include the length for binary strings. Note that a copy of the string is made and stored. If this causes exceedingly large memory consumption, consider using InputArray instead.

void vtkXdmfReader::SetBinaryInputString ( const char *  ,
int  len 
)

Specify the InputString for use when reading from a character array.

Optionally include the length for binary strings. Note that a copy of the string is made and stored. If this causes exceedingly large memory consumption, consider using InputArray instead.

void vtkXdmfReader::SetInputString ( const std::string &  input)
inline

Specify the InputString for use when reading from a character array.

Optionally include the length for binary strings. Note that a copy of the string is made and stored. If this causes exceedingly large memory consumption, consider using InputArray instead.

Definition at line 234 of file vtkXdmfReader.h.

int vtkXdmfReader::ProcessRequest ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

see vtkAlgorithm for details

Reimplemented from vtkDataObjectAlgorithm.

virtual int vtkXdmfReader::RequestDataObjectInternal ( vtkInformationVector outputVector)
protectedvirtual
int vtkXdmfReader::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

int vtkXdmfReader::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

int vtkXdmfReader::FillOutputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

Fill the output port information objects for this algorithm.

This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkDataObjectAlgorithm.

vtkXdmfArraySelection* vtkXdmfReader::GetPointArraySelection ( )
protected
vtkXdmfArraySelection* vtkXdmfReader::GetCellArraySelection ( )
protected
vtkXdmfArraySelection* vtkXdmfReader::GetGridSelection ( )
protected
vtkXdmfArraySelection* vtkXdmfReader::GetSetsSelection ( )
protected
void vtkXdmfReader::PassCachedSelections ( )
protected

Member Data Documentation

char* vtkXdmfReader::FileName
protected

Definition at line 242 of file vtkXdmfReader.h.

bool vtkXdmfReader::ReadFromInputString
protected

Definition at line 244 of file vtkXdmfReader.h.

vtkCharArray* vtkXdmfReader::InputArray
protected

Definition at line 246 of file vtkXdmfReader.h.

char* vtkXdmfReader::InputString
protected

Definition at line 248 of file vtkXdmfReader.h.

int vtkXdmfReader::InputStringLength
protected

Definition at line 249 of file vtkXdmfReader.h.

int vtkXdmfReader::InputStringPos
protected

Definition at line 250 of file vtkXdmfReader.h.

char* vtkXdmfReader::DomainName
protected

Definition at line 268 of file vtkXdmfReader.h.

int vtkXdmfReader::Stride[3]
protected

Definition at line 270 of file vtkXdmfReader.h.

unsigned int vtkXdmfReader::LastTimeIndex
protected

Definition at line 271 of file vtkXdmfReader.h.

vtkXdmfDocument* vtkXdmfReader::XdmfDocument
protected

Definition at line 273 of file vtkXdmfReader.h.

vtkXdmfArraySelection* vtkXdmfReader::PointArraysCache
protected

Definition at line 284 of file vtkXdmfReader.h.

vtkXdmfArraySelection* vtkXdmfReader::CellArraysCache
protected

Definition at line 285 of file vtkXdmfReader.h.

vtkXdmfArraySelection* vtkXdmfReader::GridsCache
protected

Definition at line 286 of file vtkXdmfReader.h.

vtkXdmfArraySelection* vtkXdmfReader::SetsCache
protected

Definition at line 287 of file vtkXdmfReader.h.

int vtkXdmfReader::SILUpdateStamp
protected

Definition at line 289 of file vtkXdmfReader.h.

XdmfReaderCachedData vtkXdmfReader::DataSetCache
protected

Definition at line 291 of file vtkXdmfReader.h.


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