VTK  9.0.1
vtkXMLPHyperTreeGridReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkXMLPHyperTreeGridReader.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 =========================================================================*/
28 #ifndef vtkXMLPHyperTreeGridReader_h
29 #define vtkXMLPHyperTreeGridReader_h
30 
31 #include "vtkIOXMLModule.h" // For export macro
33 
34 class vtkHyperTreeCursor;
35 class vtkHyperTreeGrid;
38 
40 {
41 public:
43  void PrintSelf(ostream& os, vtkIndent indent) override;
45 
47 
53 
58  void CopyOutputInformation(vtkInformation* outInfo, int port) override;
59 
60 protected:
63 
67  const char* GetDataSetName() override;
68 
74 
77 
82  void GetOutputUpdateExtent(int& piece, int& numberOfPieces);
83 
87  void SetupEmptyOutput() override;
88 
92  void SetupOutputData() override;
93 
97  void SetupOutputInformation(vtkInformation* outInfo) override;
98 
103 
108 
112  void SetupPieces(int numPieces) override;
113 
117  void SetupUpdateExtent(int piece, int numberOfPieces);
118 
122  void ReadXMLData() override;
123 
127  int CanReadPiece(int index) override;
128 
132  int ReadPrimaryElement(vtkXMLDataElement* ePrimary) override;
133 
137  void DestroyPieces() override;
138 
140 
144  int ReadPiece(vtkXMLDataElement* ePiece) override;
145 
153 
158 
160 
162  vtkInformationVector* outputVector) override;
163 
167  void PieceProgressCallback() override;
168 
174 
179  int EndPiece;
180 
183 
185 
186 private:
188  void operator=(const vtkXMLPHyperTreeGridReader&) = delete;
189 };
190 
191 #endif
vtkXMLPDataObjectReader::ReadPiece
int ReadPiece(vtkXMLDataElement *ePiece, int index)
Setup the piece reader at the given index.
vtkXMLPDataObjectReader
Superclass for PVTK XML file readers.
Definition: vtkXMLPDataObjectReader.h:30
vtkXMLPHyperTreeGridReader::GetOutput
vtkHyperTreeGrid * GetOutput(int idx)
vtkXMLPHyperTreeGridReader::SetupUpdateExtent
void SetupUpdateExtent(int piece, int numberOfPieces)
Setup the extent for the parallel reader and the piece readers.
vtkXMLPHyperTreeGridReader::CanReadPiece
int CanReadPiece(int index) override
Whether or not the current reader can read the current piece.
vtkXMLPHyperTreeGridReader::vtkXMLPHyperTreeGridReader
vtkXMLPHyperTreeGridReader()
vtkXMLPHyperTreeGridReader::RequestInformation
int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
vtkIdType
int vtkIdType
Definition: vtkType.h:338
vtkXMLPHyperTreeGridReader::GetNumberOfPointsInPiece
vtkIdType GetNumberOfPointsInPiece(int piece)
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:36
vtkXMLPHyperTreeGridReader
Read PVTK XML HyperTreeGrid files.
Definition: vtkXMLPHyperTreeGridReader.h:40
vtkXMLPHyperTreeGridReader::SetupEmptyOutput
void SetupEmptyOutput() override
Initialize current output.
vtkXMLPHyperTreeGridReader::SetupOutputData
void SetupOutputData() override
Initialize current output data.
vtkXMLPHyperTreeGridReader::ReadPieceData
int ReadPieceData(int index)
Actually read the current piece data.
vtkXMLPHyperTreeGridReader::UpdatePiece
int UpdatePiece
The update request.
Definition: vtkXMLPHyperTreeGridReader.h:172
vtkHyperTreeGridNonOrientedCursor
Objects for traversal a HyperTreeGrid.
Definition: vtkHyperTreeGridNonOrientedCursor.h:51
vtkXMLPHyperTreeGridReader::ReadXMLData
void ReadXMLData() override
Setup the readers and then read the input data.
vtkXMLPHyperTreeGridReader::CopyOutputInformation
void CopyOutputInformation(vtkInformation *outInfo, int port) override
For the specified port, copy the information this reader sets up in SetupOutputInformation to outInfo...
vtkXMLPHyperTreeGridReader::~vtkXMLPHyperTreeGridReader
~vtkXMLPHyperTreeGridReader() override
vtkXMLPHyperTreeGridReader::FillOutputPortInformation
int FillOutputPortInformation(int, vtkInformation *) override
Fill the output port information objects for this algorithm.
vtkX3D::port
@ port
Definition: vtkX3D.h:453
vtkXMLPHyperTreeGridReader::EndPiece
int EndPiece
Definition: vtkXMLPHyperTreeGridReader.h:179
vtkHyperTreeCursor
Objects for depth-first traversal HyperTrees.
Definition: vtkHyperTreeCursor.h:43
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:34
vtkXMLPHyperTreeGridReader::StartPiece
int StartPiece
The range of pieces from the file that will form the UpdatePiece.
Definition: vtkXMLPHyperTreeGridReader.h:178
vtkXMLPHyperTreeGridReader::ReadPiece
int ReadPiece(vtkXMLDataElement *ePiece) override
Setup the current piece reader.
vtkXMLPHyperTreeGridReader::GetPieceInputAsHyperTreeGrid
vtkHyperTreeGrid * GetPieceInputAsHyperTreeGrid(int piece)
vtkXMLDataElement
Represents an XML element and those nested inside.
Definition: vtkXMLDataElement.h:37
vtkXMLPHyperTreeGridReader::SetupOutputInformation
void SetupOutputInformation(vtkInformation *outInfo) override
Setup the output's information.
vtkXMLPHyperTreeGridReader::TotalNumberOfPoints
vtkIdType TotalNumberOfPoints
Definition: vtkXMLPHyperTreeGridReader.h:181
vtkXMLPHyperTreeGridReader::GetOutputUpdateExtent
void GetOutputUpdateExtent(int &piece, int &numberOfPieces)
Get the current piece index and the total number of pieces in the dataset Here let's consider a piece...
vtkXMLPHyperTreeGridReader::DestroyPieces
void DestroyPieces() override
Delete all piece readers and related information.
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:65
vtkXMLPHyperTreeGridReader::ReadPrimaryElement
int ReadPrimaryElement(vtkXMLDataElement *ePrimary) override
Pipeline execute data driver.
vtkXMLPHyperTreeGridReader::ReadPieceData
int ReadPieceData()
vtkXMLPHyperTreeGridReader::GetDataSetName
const char * GetDataSetName() override
Return the type of the dataset being read.
vtkXMLPHyperTreeGridReader::CreatePieceReader
vtkXMLHyperTreeGridReader * CreatePieceReader()
Create a reader according to the data to read.
vtkXMLPHyperTreeGridReader::SetupNextPiece
void SetupNextPiece()
no-op
vtkXMLPHyperTreeGridReader::New
static vtkXMLPHyperTreeGridReader * New()
vtkXMLPHyperTreeGridReader::GetNumberOfPoints
vtkIdType GetNumberOfPoints()
Get the number of vertices available in the input.
vtkXMLHyperTreeGridReader
Read VTK XML HyperTreeGrid files.
Definition: vtkXMLHyperTreeGridReader.h:57
vtkXMLPHyperTreeGridReader::SetupPieces
void SetupPieces(int numPieces) override
Setup the number of pieces to be read.
vtkXMLPHyperTreeGridReader::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkXMLPHyperTreeGridReader::SetupOutputTotals
void SetupOutputTotals()
Initialize the number of vertices from all the pieces.
vtkXMLPHyperTreeGridReader::GetOutput
vtkHyperTreeGrid * GetOutput()
Get the reader's output.
vtkXMLPHyperTreeGridReader::UpdateNumberOfPieces
int UpdateNumberOfPieces
Definition: vtkXMLPHyperTreeGridReader.h:173
vtkXMLPHyperTreeGridReader::PieceReaders
vtkXMLHyperTreeGridReader ** PieceReaders
Definition: vtkXMLPHyperTreeGridReader.h:184
vtkXMLPHyperTreeGridReader::RecursivelyProcessTree
void RecursivelyProcessTree(vtkHyperTreeGridNonOrientedCursor *inCursor, vtkHyperTreeGridNonOrientedCursor *outCursor)
vtkXMLPHyperTreeGridReader::PieceStartIndex
vtkIdType PieceStartIndex
Definition: vtkXMLPHyperTreeGridReader.h:182
vtkXMLPDataObjectReader.h
vtkX3D::index
@ index
Definition: vtkX3D.h:252
vtkXMLPHyperTreeGridReader::GetOutputAsHyperTreeGrid
vtkHyperTreeGrid * GetOutputAsHyperTreeGrid()
vtkXMLPHyperTreeGridReader::PieceProgressCallback
void PieceProgressCallback() override
Callback registered with the PieceProgressObserver.
vtkHyperTreeGrid
A dataset containing a grid of vtkHyperTree instances arranged as a rectilinear grid.
Definition: vtkHyperTreeGrid.h:97