forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkXMLUniformGridAMRReader.h
124 lines (101 loc) · 4.94 KB
/
vtkXMLUniformGridAMRReader.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/*=========================================================================
Program: ParaView
Module: vtkXMLUniformGridAMRReader.h
Copyright (c) Kitware, Inc.
All rights reserved.
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkXMLUniformGridAMRReader - Reader for amr datasets (vtkOverlappingAMR
// or vtkNonOverlappingAMR).
// .SECTION Description
// 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.
#ifndef __vtkXMLUniformGridAMRReader_h
#define __vtkXMLUniformGridAMRReader_h
#include "vtkIOXMLModule.h" // For export macro
#include "vtkXMLCompositeDataReader.h"
#include "vtkSmartPointer.h" // needed for vtkSmartPointer.
class vtkOverlappingAMR;
class vtkUniformGridAMR;
class VTKIOXML_EXPORT vtkXMLUniformGridAMRReader :
public vtkXMLCompositeDataReader
{
public:
static vtkXMLUniformGridAMRReader* New();
vtkTypeMacro(vtkXMLUniformGridAMRReader,vtkXMLCompositeDataReader);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// 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.
vtkSetMacro(MaximumLevelsToReadByDefault, unsigned int);
vtkGetMacro(MaximumLevelsToReadByDefault, unsigned int);
protected:
vtkXMLUniformGridAMRReader();
~vtkXMLUniformGridAMRReader();
// Test if the reader can read a file with the given version number.
virtual int CanReadFileVersion(int major, int minor)
{
return (major == 1 && minor == 1)? 1 : 0;
}
// Description:
// 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.
virtual int CanReadFileWithDataType(const char* dsname);
// Description:
// 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.
virtual int ReadVTKFile(vtkXMLDataElement* eVTKFile);
// Description:
// 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.
virtual int ReadPrimaryElement(vtkXMLDataElement* ePrimary);
// Description:
// 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.
virtual int RequestDataObject(vtkInformation *request,
vtkInformationVector **inputVector, vtkInformationVector *outputVector);
// Description:
// Overridden to put vtkOverlappingAMR in the pipeline if
// available/applicable.
virtual int RequestInformation(vtkInformation *request,
vtkInformationVector **inputVector, vtkInformationVector *outputVector);
// Get the name of the data set being read.
virtual const char* GetDataSetName();
// Read the XML element for the subtree of a the composite dataset.
// dataSetIndex is used to rank the leaf nodes in an inorder traversal.
virtual void ReadComposite(vtkXMLDataElement* element,
vtkCompositeDataSet* composite, const char* filePath,
unsigned int &dataSetIndex);
// Read the vtkDataSet (a leaf) in the composite dataset.
virtual vtkDataSet* ReadDataset(vtkXMLDataElement* xmlElem, const char* filePath);
vtkSmartPointer<vtkOverlappingAMR> Metadata;
unsigned int MaximumLevelsToReadByDefault;
private:
vtkXMLUniformGridAMRReader(const vtkXMLUniformGridAMRReader&); // Not implemented.
void operator=(const vtkXMLUniformGridAMRReader&); // Not implemented.
char* OutputDataType;
vtkSetStringMacro(OutputDataType);
};
#endif