VTK  9.1.0
vtkXMLPUnstructuredDataReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkXMLPUnstructuredDataReader.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 vtkXMLPUnstructuredDataReader_h
27 #define vtkXMLPUnstructuredDataReader_h
28 
29 #include "vtkIOXMLModule.h" // For export macro
30 #include "vtkXMLPDataReader.h"
31 
32 class vtkAbstractArray;
33 class vtkPointSet;
34 class vtkCellArray;
36 
37 class VTKIOXML_EXPORT vtkXMLPUnstructuredDataReader : public vtkXMLPDataReader
38 {
39 public:
41  void PrintSelf(ostream& os, vtkIndent indent) override;
42 
43  // For the specified port, copy the information this reader sets up in
44  // SetupOutputInformation to outInfo
45  void CopyOutputInformation(vtkInformation* outInfo, int port) override;
46 
47 protected:
50 
52  vtkInformationVector* outputVector) override;
53 
56  virtual void SetupOutputTotals();
57  virtual void SetupNextPiece();
60  void CopyArrayForPoints(vtkAbstractArray* inArray, vtkAbstractArray* outArray) override;
61 
62  void SetupEmptyOutput() override;
63 
64  // Setup the output's information.
65  void SetupOutputInformation(vtkInformation* outInfo) override;
66 
67  void SetupOutputData() override;
68  virtual void GetOutputUpdateExtent(int& piece, int& numberOfPieces, int& ghostLevel) = 0;
69 
70  // Pipeline execute data driver. Called by vtkXMLReader.
71  void ReadXMLData() override;
72  int ReadPrimaryElement(vtkXMLDataElement* ePrimary) override;
73  void SetupUpdateExtent(int piece, int numberOfPieces, int ghostLevel);
74 
75  int ReadPieceData() override;
76  void CopyCellArray(vtkIdType totalNumberOfCells, vtkCellArray* inCells, vtkCellArray* outCells);
77 
78  // Get the number of points/cells in the given piece. Valid after
79  // UpdateInformation.
80  virtual vtkIdType GetNumberOfPointsInPiece(int piece);
81  virtual vtkIdType GetNumberOfCellsInPiece(int piece);
82 
83  // The update request.
87 
88  // The range of pieces from the file that will form the UpdatePiece.
90  int EndPiece;
94 
95  // The PPoints element with point information.
97 
98 private:
100  void operator=(const vtkXMLPUnstructuredDataReader&) = delete;
101 };
102 
103 #endif
vtkXMLPUnstructuredDataReader::SetupOutputData
void SetupOutputData() override
Initialize the output data.
vtkXMLPUnstructuredDataReader::CopyArrayForPoints
void CopyArrayForPoints(vtkAbstractArray *inArray, vtkAbstractArray *outArray) override
vtkXMLPUnstructuredDataReader
Superclass for parallel unstructured data XML readers.
Definition: vtkXMLPUnstructuredDataReader.h:38
vtkXMLPUnstructuredDataReader::GetNumberOfCellsInPiece
virtual vtkIdType GetNumberOfCellsInPiece(int piece)
vtkIdType
int vtkIdType
Definition: vtkType.h:332
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:145
vtkXMLPUnstructuredDataReader::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkXMLPUnstructuredDataReader::SetupOutputInformation
void SetupOutputInformation(vtkInformation *outInfo) override
vtkXMLPUnstructuredDataReader::SetupUpdateExtent
void SetupUpdateExtent(int piece, int numberOfPieces, int ghostLevel)
vtkXMLPUnstructuredDataReader::GetNumberOfPointsInPiece
virtual vtkIdType GetNumberOfPointsInPiece(int piece)
vtkXMLPUnstructuredDataReader::ReadPrimaryElement
int ReadPrimaryElement(vtkXMLDataElement *ePrimary) override
Read the information relative to the dataset and allocate the needed structures according to it.
vtkXMLPUnstructuredDataReader::EndPiece
int EndPiece
Definition: vtkXMLPUnstructuredDataReader.h:90
vtkXMLPUnstructuredDataReader::vtkXMLPUnstructuredDataReader
vtkXMLPUnstructuredDataReader()
vtkXMLPUnstructuredDataReader::ReadPieceData
int ReadPieceData() override
Actually read the current piece data.
vtkXMLPUnstructuredDataReader::CopyOutputInformation
void CopyOutputInformation(vtkInformation *outInfo, int port) override
vtkXMLPUnstructuredDataReader::CopyCellArray
void CopyCellArray(vtkIdType totalNumberOfCells, vtkCellArray *inCells, vtkCellArray *outCells)
vtkX3D::port
@ port
Definition: vtkX3D.h:453
vtkXMLPUnstructuredDataReader::~vtkXMLPUnstructuredDataReader
~vtkXMLPUnstructuredDataReader() override
vtkXMLPUnstructuredDataReader::GetNumberOfPoints
vtkIdType GetNumberOfPoints() override
vtkXMLPUnstructuredDataReader::SetupEmptyOutput
void SetupEmptyOutput() override
vtkXMLPDataReader.h
vtkXMLUnstructuredDataReader
Superclass for unstructured data XML readers.
Definition: vtkXMLUnstructuredDataReader.h:38
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:113
vtkXMLPUnstructuredDataReader::StartPoint
vtkIdType StartPoint
Definition: vtkXMLPUnstructuredDataReader.h:93
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:290
vtkXMLDataElement
Represents an XML element and those nested inside.
Definition: vtkXMLDataElement.h:37
vtkXMLPUnstructuredDataReader::PPointsElement
vtkXMLDataElement * PPointsElement
Definition: vtkXMLPUnstructuredDataReader.h:96
vtkXMLPUnstructuredDataReader::UpdateGhostLevel
int UpdateGhostLevel
Definition: vtkXMLPUnstructuredDataReader.h:86
vtkAbstractArray
Abstract superclass for all arrays.
Definition: vtkAbstractArray.h:76
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:183
vtkXMLPUnstructuredDataReader::GetOutputAsPointSet
vtkPointSet * GetOutputAsPointSet()
vtkXMLPUnstructuredDataReader::StartPiece
int StartPiece
Definition: vtkXMLPUnstructuredDataReader.h:89
vtkPointSet
concrete class for storing a set of points
Definition: vtkPointSet.h:106
vtkXMLPUnstructuredDataReader::GetNumberOfCells
vtkIdType GetNumberOfCells() override
vtkXMLPUnstructuredDataReader::SetupOutputTotals
virtual void SetupOutputTotals()
vtkXMLPUnstructuredDataReader::TotalNumberOfPoints
vtkIdType TotalNumberOfPoints
Definition: vtkXMLPUnstructuredDataReader.h:91
vtkXMLPUnstructuredDataReader::RequestInformation
int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
vtkXMLPUnstructuredDataReader::UpdatePieceId
int UpdatePieceId
Definition: vtkXMLPUnstructuredDataReader.h:84
vtkXMLPUnstructuredDataReader::TotalNumberOfCells
vtkIdType TotalNumberOfCells
Definition: vtkXMLPUnstructuredDataReader.h:92
vtkXMLPUnstructuredDataReader::GetPieceInputAsPointSet
vtkPointSet * GetPieceInputAsPointSet(int piece)
vtkXMLPUnstructuredDataReader::GetOutputUpdateExtent
virtual void GetOutputUpdateExtent(int &piece, int &numberOfPieces, int &ghostLevel)=0
vtkXMLPDataReader
Superclass for PVTK XML file readers that read vtkDataSets.
Definition: vtkXMLPDataReader.h:38
vtkXMLPUnstructuredDataReader::ReadXMLData
void ReadXMLData() override
vtkXMLPUnstructuredDataReader::SetupNextPiece
virtual void SetupNextPiece()
vtkXMLPUnstructuredDataReader::UpdateNumberOfPieces
int UpdateNumberOfPieces
Definition: vtkXMLPUnstructuredDataReader.h:85