VTK  9.2.6
vtkXMLUnstructuredDataReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkXMLUnstructuredDataReader.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 =========================================================================*/
26 #ifndef vtkXMLUnstructuredDataReader_h
27 #define vtkXMLUnstructuredDataReader_h
28 
29 #include "vtkIOXMLModule.h" // For export macro
30 #include "vtkXMLDataReader.h"
31 
32 class vtkCellArray;
33 class vtkIdTypeArray;
34 class vtkPointSet;
36 
37 class VTKIOXML_EXPORT vtkXMLUnstructuredDataReader : public vtkXMLDataReader
38 {
39 public:
41  void PrintSelf(ostream& os, vtkIndent indent) override;
42 
46  vtkIdType GetNumberOfPoints() override;
47 
51  vtkIdType GetNumberOfCells() override;
52 
56  virtual vtkIdType GetNumberOfPieces();
57 
64  void SetupUpdateExtent(int piece, int numberOfPieces, int ghostLevel);
65 
66  // For the specified port, copy the information this reader sets up in
67  // SetupOutputInformation to outInfo
68  void CopyOutputInformation(vtkInformation* outInfo, int port) override;
69 
70 protected:
72  ~vtkXMLUnstructuredDataReader() override;
73 
74  vtkPointSet* GetOutputAsPointSet();
75  vtkXMLDataElement* FindDataArrayWithName(vtkXMLDataElement* eParent, const char* name);
76 
77  // note that these decref the input array and return an array with a
78  // new reference:
79  vtkIdTypeArray* ConvertToIdTypeArray(vtkDataArray* a);
80  vtkUnsignedCharArray* ConvertToUnsignedCharArray(vtkDataArray* a);
81 
82  // Pipeline execute data driver. Called by vtkXMLReader.
83  void ReadXMLData() override;
84 
85  void SetupEmptyOutput() override;
86  virtual void GetOutputUpdateExtent(int& piece, int& numberOfPieces, int& ghostLevel) = 0;
87  virtual void SetupOutputTotals();
88  virtual void SetupNextPiece();
89  void SetupPieces(int numPieces) override;
90  void DestroyPieces() override;
91 
92  // Setup the output's information.
93  void SetupOutputInformation(vtkInformation* outInfo) override;
94 
95  void SetupOutputData() override;
96  int ReadPiece(vtkXMLDataElement* ePiece) override;
97  int ReadPieceData() override;
98  int ReadCellArray(vtkIdType numberOfCells, vtkIdType totalNumberOfCells,
99  vtkXMLDataElement* eCells, vtkCellArray* outCells);
100 
101  // Read faces and faceoffsets arrays for unstructured grid with polyhedon cells
102  int ReadFaceArray(vtkIdType numberOfCells, vtkXMLDataElement* eCells, vtkIdTypeArray* outFaces,
103  vtkIdTypeArray* outFaceOffsets);
104 
105  // Read a data array whose tuples coorrespond to points.
106  int ReadArrayForPoints(vtkXMLDataElement* da, vtkAbstractArray* outArray) override;
107 
108  // Get the number of points/cells in the given piece. Valid after
109  // UpdateInformation.
110  virtual vtkIdType GetNumberOfPointsInPiece(int piece);
111  virtual vtkIdType GetNumberOfCellsInPiece(int piece) = 0;
112 
113  // The update request.
117 
118  // The range of pieces from the file that will form the UpdatePiece.
120  int EndPiece;
124 
125  // The Points element for each piece.
128 
130  unsigned long PointsOffset;
131  int PointsNeedToReadTimeStep(vtkXMLDataElement* eNested);
132  int CellsNeedToReadTimeStep(
133  vtkXMLDataElement* eNested, int& cellstimestep, unsigned long& cellsoffset);
134 
135 private:
137  void operator=(const vtkXMLUnstructuredDataReader&) = delete;
138 };
139 
140 #endif
virtual void SetupEmptyOutput()=0
Represents an XML element and those nested inside.
Store vtkAlgorithm input/output information.
Abstract superclass for all arrays.
concrete class for storing a set of points
Definition: vtkPointSet.h:69
Superclass for unstructured data XML readers.
dynamic, self-adjusting array of vtkIdType
int vtkIdType
Definition: vtkType.h:332
void CopyOutputInformation(vtkInformation *outInfo, int port) override
void ReadXMLData() override
virtual void DestroyPieces()
a simple class to control print indentation
Definition: vtkIndent.h:39
virtual void SetupPieces(int numPieces)
void SetupOutputData() override
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
virtual vtkIdType GetNumberOfPoints()=0
Get the number of points in the output.
virtual int ReadArrayForPoints(vtkXMLDataElement *da, vtkAbstractArray *outArray)
dynamic, self-adjusting array of unsigned char
virtual vtkIdType GetNumberOfCells()=0
Get the number of cells in the output.
object to represent cell connectivity
Definition: vtkCellArray.h:186
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)
void SetupOutputInformation(vtkInformation *outInfo) override
virtual int ReadPieceData()