VTK
vtkXMLUniformGridAMRReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: vtkXMLUniformGridAMRReader.h
5 
6  Copyright (c) Kitware, Inc.
7  All rights reserved.
8  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
34 #ifndef vtkXMLUniformGridAMRReader_h
35 #define vtkXMLUniformGridAMRReader_h
36 
37 #include "vtkIOXMLModule.h" // For export macro
39 #include "vtkSmartPointer.h" // needed for vtkSmartPointer.
40 
41 class vtkOverlappingAMR;
42 class vtkUniformGridAMR;
43 
44 class VTKIOXML_EXPORT vtkXMLUniformGridAMRReader :
46 {
47 public:
50  void PrintSelf(ostream& os, vtkIndent indent) override;
51 
53 
62  vtkSetMacro(MaximumLevelsToReadByDefault, unsigned int);
63  vtkGetMacro(MaximumLevelsToReadByDefault, unsigned int);
65 
66 protected:
69 
76  int CanReadFileWithDataType(const char* dsname) override;
77 
84  int ReadVTKFile(vtkXMLDataElement* eVTKFile) override;
85 
92  int ReadPrimaryElement(vtkXMLDataElement* ePrimary) override;
93 
100  vtkInformationVector **inputVector, vtkInformationVector *outputVector) override;
101 
107  vtkInformationVector **inputVector, vtkInformationVector *outputVector) override;
108 
109  // Get the name of the data set being read.
110  const char* GetDataSetName() override;
111 
112  // Read the XML element for the subtree of a the composite dataset.
113  // dataSetIndex is used to rank the leaf nodes in an inorder traversal.
115  vtkCompositeDataSet* composite, const char* filePath,
116  unsigned int &dataSetIndex) override;
117 
118  // Read the vtkDataSet (a leaf) in the composite dataset.
119  vtkDataSet* ReadDataset(vtkXMLDataElement* xmlElem, const char* filePath) override;
120 
123 
124 private:
126  void operator=(const vtkXMLUniformGridAMRReader&) = delete;
127 
128  char* OutputDataType;
129  vtkSetStringMacro(OutputDataType);
130 };
131 
132 #endif
vtkXMLUniformGridAMRReader::RequestDataObject
int RequestDataObject(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
Overridden to create an output data object based on the type in the file.
vtkXMLUniformGridAMRReader::MaximumLevelsToReadByDefault
unsigned int MaximumLevelsToReadByDefault
Definition: vtkXMLUniformGridAMRReader.h:122
vtkXMLUniformGridAMRReader::ReadComposite
void ReadComposite(vtkXMLDataElement *element, vtkCompositeDataSet *composite, const char *filePath, unsigned int &dataSetIndex) override
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:42
vtkSmartPointer< vtkOverlappingAMR >
vtkXMLUniformGridAMRReader::ReadPrimaryElement
int ReadPrimaryElement(vtkXMLDataElement *ePrimary) override
Read the meta-data from the AMR from the file.
vtkXMLUniformGridAMRReader::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkCompositeDataSet
abstract superclass for composite (multi-block or AMR) datasets
Definition: vtkCompositeDataSet.h:52
vtkXMLUniformGridAMRReader::CanReadFileWithDataType
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 ...
vtkXMLCompositeDataReader
Reader for multi-group datasets.
Definition: vtkXMLCompositeDataReader.h:42
vtkXMLCompositeDataReader.h
vtkXMLUniformGridAMRReader::~vtkXMLUniformGridAMRReader
~vtkXMLUniformGridAMRReader() override
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkXMLUniformGridAMRReader::GetDataSetName
const char * GetDataSetName() override
vtkSmartPointer.h
vtkXMLDataElement
Represents an XML element and those nested inside.
Definition: vtkXMLDataElement.h:37
vtkOverlappingAMR
hierarchical dataset of vtkUniformGrids
Definition: vtkOverlappingAMR.h:47
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:63
vtkXMLUniformGridAMRReader::ReadDataset
vtkDataSet * ReadDataset(vtkXMLDataElement *xmlElem, const char *filePath) override
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkXMLUniformGridAMRReader::Metadata
vtkSmartPointer< vtkOverlappingAMR > Metadata
Definition: vtkXMLUniformGridAMRReader.h:121
vtkXMLUniformGridAMRReader::New
static vtkXMLUniformGridAMRReader * New()
vtkXMLUniformGridAMRReader::RequestInformation
int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
Overridden to put vtkOverlappingAMR in the pipeline if available/applicable.
vtkXMLUniformGridAMRReader
Reader for amr datasets (vtkOverlappingAMR or vtkNonOverlappingAMR).
Definition: vtkXMLUniformGridAMRReader.h:46
vtkXMLUniformGridAMRReader::vtkXMLUniformGridAMRReader
vtkXMLUniformGridAMRReader()
vtkXMLUniformGridAMRReader::ReadVTKFile
int ReadVTKFile(vtkXMLDataElement *eVTKFile) override
Read the top-level element from the file.
vtkUniformGridAMR
Definition: vtkUniformGridAMR.h:34