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 
44 
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:
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
vtkXMLStructuredDataReader::SetOutputExtent
virtual void SetOutputExtent(int *extent)=0
vtkXMLStructuredDataReader::PieceExtents
int * PieceExtents
Definition: vtkXMLStructuredDataReader.h:82
vtkXMLStructuredDataReader::WholeSlices
vtkTypeBool WholeSlices
Definition: vtkXMLStructuredDataReader.h:89
vtkXMLStructuredDataReader::CopyOutputInformation
void CopyOutputInformation(vtkInformation *outInfo, int port) override
For the specified port, copy the information this reader sets up in SetupOutputInformation to outInfo...
vtkXMLStructuredDataReader::~vtkXMLStructuredDataReader
~vtkXMLStructuredDataReader() override
vtkX3D::type
@ type
Definition: vtkX3D.h:516
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkXMLStructuredDataReader::ReadArrayForPoints
int ReadArrayForPoints(vtkXMLDataElement *da, vtkAbstractArray *outArray) override
vtkXMLStructuredDataReader::ReadArrayForCells
int ReadArrayForCells(vtkXMLDataElement *da, vtkAbstractArray *outArray) override
vtkXMLStructuredDataReader::GetNumberOfCells
vtkIdType GetNumberOfCells() override
Get the number of cells in the output.
vtkXMLStructuredDataReader::vtkXMLStructuredDataReader
vtkXMLStructuredDataReader()
vtkXMLStructuredDataReader::GetNumberOfPoints
vtkIdType GetNumberOfPoints() override
Get the number of points in the output.
vtkXMLDataReader
Superclass for VTK XML file readers.
Definition: vtkXMLDataReader.h:36
vtkXMLStructuredDataReader::ReadPiece
int ReadPiece(vtkXMLDataElement *ePiece) override
vtkXMLStructuredDataReader::PiecePointIncrements
vtkIdType * PiecePointIncrements
Definition: vtkXMLStructuredDataReader.h:84
vtkX3D::port
@ port
Definition: vtkX3D.h:447
vtkXMLStructuredDataReader::ReadPrimaryElement
int ReadPrimaryElement(vtkXMLDataElement *ePrimary) override
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkXMLDataReader.h
vtkXMLStructuredDataReader::SetupPieces
void SetupPieces(int numPieces) override
vtkXMLDataElement
Represents an XML element and those nested inside.
Definition: vtkXMLDataElement.h:37
vtkXMLStructuredDataReader
Superclass for structured data XML readers.
Definition: vtkXMLStructuredDataReader.h:35
vtkXMLStructuredDataReader::PiecePointDimensions
int * PiecePointDimensions
Definition: vtkXMLStructuredDataReader.h:83
vtkAbstractArray
Abstract superclass for all arrays.
Definition: vtkAbstractArray.h:79
vtkXMLStructuredDataReader::DestroyPieces
void DestroyPieces() override
vtkXMLStructuredDataReader::SetupOutputInformation
void SetupOutputInformation(vtkInformation *outInfo) override
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkXMLStructuredDataReader::ReadXMLData
void ReadXMLData() override
vtkXMLReader::FieldType
FieldType
Definition: vtkXMLReader.h:50
vtkXMLStructuredDataReader::PieceCellIncrements
vtkIdType * PieceCellIncrements
Definition: vtkXMLStructuredDataReader.h:86
vtkX3D::extent
@ extent
Definition: vtkX3D.h:345
vtkXMLStructuredDataReader::PieceCellDimensions
int * PieceCellDimensions
Definition: vtkXMLStructuredDataReader.h:85
vtkXMLStructuredDataReader::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkXMLStructuredDataReader::SetupEmptyOutput
void SetupEmptyOutput() override
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkXMLStructuredDataReader::ReadSubExtent
virtual int ReadSubExtent(int *inExtent, int *inDimensions, vtkIdType *inIncrements, int *outExtent, int *outDimensions, vtkIdType *outIncrements, int *subExtent, int *subDimensions, vtkXMLDataElement *da, vtkAbstractArray *array, FieldType type)