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

Reader for amr datasets (vtkOverlappingAMR or vtkNonOverlappingAMR). More...

#include <vtkXMLUniformGridAMRReader.h>

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

Public Types

typedef vtkXMLCompositeDataReader Superclass
 
- Public Types inherited from vtkXMLCompositeDataReader
enum  { Block, Interleave }
 
typedef vtkXMLReader Superclass
 
- Public Types inherited from vtkXMLReader
enum  FieldType { POINT_DATA, CELL_DATA, OTHER }
 
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkXMLUniformGridAMRReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetMaximumLevelsToReadByDefault (unsigned int)
 This reader supports demand-driven heavy data reading i.e. More...
 
virtual unsigned int GetMaximumLevelsToReadByDefault ()
 
- Public Member Functions inherited from vtkXMLCompositeDataReader
vtkXMLCompositeDataReaderNewInstance () const
 
vtkCompositeDataSetGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkCompositeDataSetGetOutput (int)
 
virtual void SetPieceDistribution (int)
 Set the strategy for assigning files to parallel readers. More...
 
virtual int GetPieceDistribution ()
 Set the strategy for assigning files to parallel readers. More...
 
- Public Member Functions inherited from vtkXMLReader
vtkXMLReaderNewInstance () const
 
virtual void SetFileName (const char *)
 Get/Set the name of the input file. More...
 
virtual char * GetFileName ()
 
virtual void SetReadFromInputString (vtkTypeBool)
 Enable reading from an InputString instead of the default, a file. More...
 
virtual vtkTypeBool GetReadFromInputString ()
 
virtual void ReadFromInputStringOn ()
 
virtual void ReadFromInputStringOff ()
 
void SetInputString (const std::string &s)
 
virtual int CanReadFile (const char *name)
 Test whether the file (type) with the given name can be read by this reader. More...
 
vtkDataSetGetOutputAsDataSet ()
 Get the output as a vtkDataSet pointer. More...
 
vtkDataSetGetOutputAsDataSet (int index)
 
virtual vtkDataArraySelectionGetPointDataArraySelection ()
 Get the data array selection tables used to configure which data arrays are loaded by the reader. More...
 
virtual vtkDataArraySelectionGetCellDataArraySelection ()
 
virtual vtkDataArraySelectionGetColumnArraySelection ()
 
int GetNumberOfPointArrays ()
 Get the number of point, cell or column arrays available in the input. More...
 
int GetNumberOfCellArrays ()
 
int GetNumberOfColumnArrays ()
 
const char * GetPointArrayName (int index)
 Get the name of the point, cell or column array with the given index in the input. More...
 
const char * GetCellArrayName (int index)
 
const char * GetColumnArrayName (int index)
 
int GetPointArrayStatus (const char *name)
 Get/Set whether the point, cell or column array with the given name is to be read. More...
 
int GetCellArrayStatus (const char *name)
 
void SetPointArrayStatus (const char *name, int status)
 
void SetCellArrayStatus (const char *name, int status)
 
int GetColumnArrayStatus (const char *name)
 
void SetColumnArrayStatus (const char *name, int status)
 
virtual void CopyOutputInformation (vtkInformation *vtkNotUsed(outInfo), int vtkNotUsed(port))
 
virtual void SetTimeStep (int)
 Which TimeStep to read. More...
 
virtual int GetTimeStep ()
 
virtual int GetNumberOfTimeSteps ()
 
virtual intGetTimeStepRange ()
 Which TimeStepRange to read. More...
 
virtual void GetTimeStepRange (int &, int &)
 
virtual void GetTimeStepRange (int[2])
 
virtual void SetTimeStepRange (int, int)
 
void SetTimeStepRange (int[2])
 
vtkXMLDataParserGetXMLParser ()
 Returns the internal XML parser. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. More...
 
void SetReaderErrorObserver (vtkCommand *)
 Set/get the ErrorObserver for the internal reader This is useful for applications that want to catch error messages. More...
 
virtual vtkCommandGetReaderErrorObserver ()
 
void SetParserErrorObserver (vtkCommand *)
 Set/get the ErrorObserver for the internal xml parser This is useful for applications that want to catch error messages. More...
 
virtual vtkCommandGetParserErrorObserver ()
 
- 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...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
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 Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the 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 ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
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)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
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 SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
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 void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
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)
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkXMLUniformGridAMRReaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLUniformGridAMRReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkXMLCompositeDataReader
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLCompositeDataReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkXMLReader
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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
 
 vtkXMLUniformGridAMRReader ()
 
 ~vtkXMLUniformGridAMRReader () override
 
int CanReadFileWithDataType (const char *dsname) override
 This method is used by CanReadFile() to check if the reader can read an XML with the primary element with the given name. More...
 
int ReadVTKFile (vtkXMLDataElement *eVTKFile) override
 Read the top-level element from the file. More...
 
int ReadPrimaryElement (vtkXMLDataElement *ePrimary) override
 Read the meta-data from the AMR from the file. More...
 
int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 Overridden to create an output data object based on the type in the file. More...
 
int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 Overridden to put vtkOverlappingAMR in the pipeline if available/applicable. More...
 
const char * GetDataSetName () override
 
void ReadComposite (vtkXMLDataElement *element, vtkCompositeDataSet *composite, const char *filePath, unsigned int &dataSetIndex) override
 
vtkDataSetReadDataset (vtkXMLDataElement *xmlElem, const char *filePath) override
 
- Protected Member Functions inherited from vtkXMLCompositeDataReader
 vtkXMLCompositeDataReader ()
 
 ~vtkXMLCompositeDataReader () override
 
vtkXMLDataElementGetPrimaryElement ()
 
void ReadXMLData () override
 
void SetupEmptyOutput () override
 
int FillOutputPortInformation (int, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
vtkExecutiveCreateDefaultExecutive () override
 Create a default executive. More...
 
std::string GetFilePath ()
 
std::string GetFileNameFromXML (vtkXMLDataElement *xmlElem, const std::string &filePath)
 
vtkXMLReaderGetReaderOfType (const char *type)
 
vtkXMLReaderGetReaderForFile (const std::string &filename)
 
void SyncDataArraySelections (vtkXMLReader *accum, vtkXMLDataElement *xmlElem, const std::string &filePath)
 
void AddChild (vtkCompositeDataSet *parent, vtkDataObject *child, vtkXMLDataElement *childXML)
 
virtual vtkDataObjectReadDataObject (vtkXMLDataElement *xmlElem, const char *filePath)
 
unsigned int CountLeaves (vtkXMLDataElement *elem)
 
int ShouldReadDataSet (unsigned int datasetIndex)
 Given the inorder index for a leaf node, this method tells if the current process should read the dataset. More...
 
bool DataSetIsValidForBlockStrategy (unsigned int datasetIndex)
 
bool DataSetIsValidForInterleaveStrategy (unsigned int datasetIndex)
 
- Protected Member Functions inherited from vtkXMLReader
 vtkXMLReader ()
 
 ~vtkXMLReader () override
 
virtual int ReadXMLInformation ()
 
virtual int CanReadFileVersion (int major, int minor)
 
virtual void SetupOutputInformation (vtkInformation *vtkNotUsed(outInfo))
 
virtual void SetupOutputData ()
 
int GetLocalDataType (vtkXMLDataElement *da, int datatype)
 If the IdType argument is present in the provided XMLDataElement and the provided dataType has the same size with VTK_ID_TYPE on this build of VTK, returns VTK_ID_TYPE. More...
 
vtkAbstractArrayCreateArray (vtkXMLDataElement *da)
 
int CreateInformationKey (vtkXMLDataElement *eInfoKey, vtkInformation *info)
 
bool ReadInformation (vtkXMLDataElement *infoRoot, vtkInformation *info)
 
virtual int OpenStream ()
 
virtual void CloseStream ()
 
virtual int OpenVTKFile ()
 
virtual void CloseVTKFile ()
 
virtual int OpenVTKString ()
 
virtual void CloseVTKString ()
 
virtual void CreateXMLParser ()
 
virtual void DestroyXMLParser ()
 
void SetupCompressor (const char *type)
 
int CanReadFileVersionString (const char *version)
 
virtual int GetFileMajorVersion ()
 
virtual int GetFileMinorVersion ()
 
int IntersectExtents (int *extent1, int *extent2, int *result)
 
int Min (int a, int b)
 
int Max (int a, int b)
 
void ComputePointDimensions (int *extent, int *dimensions)
 
void ComputePointIncrements (int *extent, vtkIdType *increments)
 
void ComputeCellDimensions (int *extent, int *dimensions)
 
void ComputeCellIncrements (int *extent, vtkIdType *increments)
 
vtkIdType GetStartTuple (int *extent, vtkIdType *increments, int i, int j, int k)
 
void ReadAttributeIndices (vtkXMLDataElement *eDSA, vtkDataSetAttributes *dsa)
 
char ** CreateStringArray (int numStrings)
 
void DestroyStringArray (int numStrings, char **strings)
 
virtual int ReadArrayValues (vtkXMLDataElement *da, vtkIdType arrayIndex, vtkAbstractArray *array, vtkIdType startIndex, vtkIdType numValues, FieldType type=OTHER)
 
void SetDataArraySelections (vtkXMLDataElement *eDSA, vtkDataArraySelection *sel)
 
int SetFieldDataInfo (vtkXMLDataElement *eDSA, int association, vtkIdType numTuples, vtkInformationVector *(&infoVector))
 
int PointDataArrayIsEnabled (vtkXMLDataElement *ePDA)
 
int CellDataArrayIsEnabled (vtkXMLDataElement *eCDA)
 
virtual void SqueezeOutputArrays (vtkDataObject *)
 
virtual void GetProgressRange (float *range)
 
virtual void SetProgressRange (const float range[2], int curStep, int numSteps)
 
virtual void SetProgressRange (const float range[2], int curStep, const float *fractions)
 
virtual void UpdateProgressDiscrete (float progress)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestDataObject (vtkInformation *vtkNotUsed(request), vtkInformationVector **vtkNotUsed(inputVector), vtkInformationVector *vtkNotUsed(outputVector))
 
void SetNumberOfTimeSteps (int num)
 
vtkDataObjectGetCurrentOutput ()
 
vtkInformationGetCurrentOutputInformation ()
 
virtual void ConvertGhostLevelsToGhostType (FieldType, vtkAbstractArray *, vtkIdType, vtkIdType)
 
void ReadFieldData ()
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm. More...
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
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)
 
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)
 
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)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
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)
 
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)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. 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)
 
- 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkSmartPointer< vtkOverlappingAMRMetadata
 
unsigned int MaximumLevelsToReadByDefault
 
- Protected Attributes inherited from vtkXMLReader
vtkXMLDataParserXMLParser
 
vtkXMLDataElementFieldDataElement
 
char * FileName
 
istream * Stream
 
vtkTypeBool ReadFromInputString
 
std::string InputString
 
vtkDataArraySelectionPointDataArraySelection
 
vtkDataArraySelectionCellDataArraySelection
 
vtkDataArraySelectionColumnArraySelection
 
vtkCallbackCommandSelectionObserver
 
int InformationError
 
int DataError
 
float ProgressRange [2]
 
vtkTimeStamp ReadMTime
 
int ReadError
 
int AxesEmpty [3]
 
int TimeStep
 
int CurrentTimeStep
 
int NumberOfTimeSteps
 
intTimeSteps
 
int TimeStepRange [2]
 
int InReadData
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- 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 vtkXMLReader
static void SelectionModifiedCallback (vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
 
static int IsTimeStepInArray (int timestep, int *timesteps, int length)
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Reader for amr datasets (vtkOverlappingAMR or vtkNonOverlappingAMR).

vtkXMLUniformGridAMRReader reads the VTK XML data files for all types of amr datasets including vtkOverlappingAMR, vtkNonOverlappingAMR and the legacy vtkHierarchicalBoxDataSet. The reader uses information in the file to determine what type of dataset is actually being read and creates the output-data object accordingly.

This reader can only read files with version 1.1 or greater. Older versions can be converted to the newer versions using vtkXMLHierarchicalBoxDataFileConverter.

Tests:
vtkXMLUniformGridAMRReader (Tests)

Definition at line 44 of file vtkXMLUniformGridAMRReader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 49 of file vtkXMLUniformGridAMRReader.h.

Constructor & Destructor Documentation

◆ vtkXMLUniformGridAMRReader()

vtkXMLUniformGridAMRReader::vtkXMLUniformGridAMRReader ( )
protected

◆ ~vtkXMLUniformGridAMRReader()

vtkXMLUniformGridAMRReader::~vtkXMLUniformGridAMRReader ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkXMLUniformGridAMRReader* vtkXMLUniformGridAMRReader::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkXMLUniformGridAMRReader::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 vtkXMLCompositeDataReader.

Reimplemented in vtkXMLHierarchicalBoxDataReader.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkXMLUniformGridAMRReader::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkXMLCompositeDataReader.

Reimplemented in vtkXMLHierarchicalBoxDataReader.

◆ NewInstance()

vtkXMLUniformGridAMRReader* vtkXMLUniformGridAMRReader::NewInstance ( ) const

◆ PrintSelf()

void vtkXMLUniformGridAMRReader::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 vtkXMLCompositeDataReader.

◆ SetMaximumLevelsToReadByDefault()

virtual void vtkXMLUniformGridAMRReader::SetMaximumLevelsToReadByDefault ( unsigned int  )
virtual

This reader supports demand-driven heavy data reading i.e.

downstream pipeline can request specific blocks from the AMR using vtkCompositeDataPipeline::UPDATE_COMPOSITE_INDICES() key in RequestUpdateExtent() pass. However, when down-stream doesn't provide any specific keys, the default behavior can be setup to read at-most N levels by default. The number of levels read can be set using this method. Set this to 0 to imply no limit. Default is 0.

◆ GetMaximumLevelsToReadByDefault()

virtual unsigned int vtkXMLUniformGridAMRReader::GetMaximumLevelsToReadByDefault ( )
virtual

◆ CanReadFileWithDataType()

int vtkXMLUniformGridAMRReader::CanReadFileWithDataType ( const char *  dsname)
overrideprotectedvirtual

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

Default implementation compares the name with the text returned by this->GetDataSetName(). Overridden to support all AMR types.

Reimplemented from vtkXMLReader.

◆ ReadVTKFile()

int vtkXMLUniformGridAMRReader::ReadVTKFile ( vtkXMLDataElement eVTKFile)
overrideprotectedvirtual

Read the top-level element from the file.

This is always the VTKFile element. Overridden to read the "type" information specified in the XML. The "type" attribute helps us identify the output data type.

Reimplemented from vtkXMLReader.

◆ ReadPrimaryElement()

int vtkXMLUniformGridAMRReader::ReadPrimaryElement ( vtkXMLDataElement ePrimary)
overrideprotectedvirtual

Read the meta-data from the AMR from the file.

Note that since ReadPrimaryElement() is only called when the filename changes, we are technically not supporting time-varying AMR datasets in this format right now.

Reimplemented from vtkXMLCompositeDataReader.

◆ RequestDataObject()

int vtkXMLUniformGridAMRReader::RequestDataObject ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotected

Overridden to create an output data object based on the type in the file.

Since this reader can handle all subclasses of vtkUniformGrid, we need to check in the file to decide what type to create.

◆ RequestInformation()

int vtkXMLUniformGridAMRReader::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

Overridden to put vtkOverlappingAMR in the pipeline if available/applicable.

Reimplemented from vtkXMLCompositeDataReader.

◆ GetDataSetName()

const char* vtkXMLUniformGridAMRReader::GetDataSetName ( )
overrideprotectedvirtual

Reimplemented from vtkXMLCompositeDataReader.

◆ ReadComposite()

void vtkXMLUniformGridAMRReader::ReadComposite ( vtkXMLDataElement element,
vtkCompositeDataSet composite,
const char *  filePath,
unsigned int dataSetIndex 
)
overrideprotectedvirtual

◆ ReadDataset()

vtkDataSet* vtkXMLUniformGridAMRReader::ReadDataset ( vtkXMLDataElement xmlElem,
const char *  filePath 
)
overrideprotectedvirtual

Reimplemented from vtkXMLCompositeDataReader.

Member Data Documentation

◆ Metadata

vtkSmartPointer<vtkOverlappingAMR> vtkXMLUniformGridAMRReader::Metadata
protected

Definition at line 121 of file vtkXMLUniformGridAMRReader.h.

◆ MaximumLevelsToReadByDefault

unsigned int vtkXMLUniformGridAMRReader::MaximumLevelsToReadByDefault
protected

Definition at line 122 of file vtkXMLUniformGridAMRReader.h.


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