VTK
vtkXMLStructuredDataReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkXMLStructuredDataReader.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm 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 =========================================================================*/
27 #ifndef vtkXMLStructuredDataReader_h
28 #define vtkXMLStructuredDataReader_h
29 
30 #include "vtkIOXMLModule.h" // For export macro
31 #include "vtkXMLDataReader.h"
32 
33 
34 class VTKIOXML_EXPORT vtkXMLStructuredDataReader : public vtkXMLDataReader
35 {
36 public:
38  void PrintSelf(ostream& os, vtkIndent indent) override;
39 
43  vtkIdType GetNumberOfPoints() override;
44 
48  vtkIdType GetNumberOfCells() override;
49 
51 
57  vtkSetMacro(WholeSlices, vtkTypeBool);
58  vtkGetMacro(WholeSlices, vtkTypeBool);
59  vtkBooleanMacro(WholeSlices, vtkTypeBool);
61 
66  void CopyOutputInformation(vtkInformation *outInfo, int port) override;
67 
68 protected:
70  ~vtkXMLStructuredDataReader() override;
71 
72  virtual void SetOutputExtent(int* extent)=0;
73  int ReadPrimaryElement(vtkXMLDataElement* ePrimary) override;
74 
75  // Pipeline execute data driver. Called by vtkXMLReader.
76  void ReadXMLData() override;
77 
78  void SetupOutputInformation(vtkInformation *outInfo) override;
79 
80  // Internal representation of pieces in the file that may have come
81  // from a streamed write.
87 
88  // Whether to read in whole slices mode.
90 
91  // The update extent and corresponding increments and dimensions.
92  int UpdateExtent[6];
93  int PointDimensions[3];
94  int CellDimensions[3];
95  vtkIdType PointIncrements[3];
96  vtkIdType CellIncrements[3];
97 
98  int WholeExtent[6];
99 
100  // The extent currently being read.
101  int SubExtent[6];
102  int SubPointDimensions[3];
103  int SubCellDimensions[3];
104 
105  // Override methods from superclass.
106  void SetupEmptyOutput() override;
107  void SetupPieces(int numPieces) override;
108  void DestroyPieces() override;
110  vtkAbstractArray* outArray) override;
112  vtkAbstractArray* outArray) override;
113 
114  // Internal utility methods.
115  int ReadPiece(vtkXMLDataElement* ePiece) override;
116  virtual int ReadSubExtent(
117  int* inExtent, int* inDimensions, vtkIdType* inIncrements,
118  int* outExtent,int* outDimensions,vtkIdType* outIncrements,
119  int* subExtent, int* subDimensions, vtkXMLDataElement* da,
121 
122 private:
124  void operator=(const vtkXMLStructuredDataReader&) = delete;
125 };
126 
127 #endif
int ReadPrimaryElement(vtkXMLDataElement *ePrimary) override
virtual void SetupEmptyOutput()=0
Represents an XML element and those nested inside.
Store vtkAlgorithm input/output information.
Abstract superclass for all arrays.
Superclass for structured data XML readers.
int vtkIdType
Definition: vtkType.h:349
void CopyOutputInformation(vtkInformation *outInfo, int port) override
int vtkTypeBool
Definition: vtkABI.h:69
void ReadXMLData() override
virtual void DestroyPieces()
a simple class to control print indentation
Definition: vtkIndent.h:39
virtual void SetupPieces(int numPieces)
virtual vtkIdType GetNumberOfPoints()=0
Get the number of points in the output.
virtual int ReadArrayForPoints(vtkXMLDataElement *da, vtkAbstractArray *outArray)
virtual vtkIdType GetNumberOfCells()=0
Get the number of cells in the output.
Superclass for VTK XML file readers.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int ReadPiece(vtkXMLDataElement *ePiece, int piece)
virtual int ReadArrayForCells(vtkXMLDataElement *da, vtkAbstractArray *outArray)
void SetupOutputInformation(vtkInformation *outInfo) override