VTK
vtkXMLTableReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkXMLTableReader.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 vtkXMLTableReader_h
28 #define vtkXMLTableReader_h
29 
30 #include "vtkIOXMLModule.h" // For export macro
31 #include "vtkXMLReader.h"
32 
33 class vtkCellArray;
34 class vtkIdTypeArray;
36 class vtkTable;
37 
38 class VTKIOXML_EXPORT vtkXMLTableReader : public vtkXMLReader
39 {
40 public:
42  void PrintSelf(ostream& os, vtkIndent indent) override;
44 
46 
50  vtkTable* GetOutput(int idx);
52 
57 
62 
69  void SetupUpdateExtent(int piece, int numberOfPieces);
70 
75  void CopyOutputInformation(vtkInformation* outInfo, int port) override;
76 
77 protected:
79  ~vtkXMLTableReader() override;
80 
85 
86  void DestroyPieces();
87 
91  const char* GetDataSetName() override;
92 
96  void GetOutputUpdateExtent(int& piece, int& numberOfPieces);
97 
102 
106  void SetupEmptyOutput() override;
107 
112 
117 
121  void SetupOutputData() override;
122 
126  void SetupOutputInformation(vtkInformation* outInfo) override;
127 
131  void SetupPieces(int numPieces);
132 
136  void ReadXMLData() override;
137 
141  int ReadPrimaryElement(vtkXMLDataElement* ePrimary) override;
142 
146  int ReadPiece(vtkXMLDataElement* ePiece, int piece);
147 
152 
156  int ReadPieceData(int);
157 
159 
169  int EndPiece;
172 
178 
183 
187  int Piece;
188 
193 
199 
201  vtkTypeInt64* RowDataOffset;
202 
203 private:
204  vtkXMLTableReader(const vtkXMLTableReader&) = delete;
205  void operator=(const vtkXMLTableReader&) = delete;
206 };
207 
208 #endif
vtkXMLReader.h
vtkXMLTableReader::UpdatedPiece
int UpdatedPiece
The update request.
Definition: vtkXMLTableReader.h:163
vtkXMLTableReader::NumberOfPieces
int NumberOfPieces
The number of Pieces of data found in the file.
Definition: vtkXMLTableReader.h:182
vtkXMLTableReader::GetOutput
vtkTable * GetOutput(int idx)
vtkXMLTableReader::GetOutput
vtkTable * GetOutput()
Get the reader's output.
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkXMLTableReader::New
static vtkXMLTableReader * New()
vtkXMLTableReader::GetDataSetName
const char * GetDataSetName() override
Get the name of the data set being read.
vtkXMLTableReader::SetupOutputInformation
void SetupOutputInformation(vtkInformation *outInfo) override
Setup the output's information.
vtkXMLTableReader::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkTable
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:69
vtkUnsignedCharArray
dynamic, self-adjusting array of unsigned char
Definition: vtkUnsignedCharArray.h:42
vtkXMLTableReader::GetNumberOfRows
vtkIdType GetNumberOfRows()
Get the number of rows in the output.
vtkXMLTableReader::~vtkXMLTableReader
~vtkXMLTableReader() override
vtkXMLTableReader::SetupEmptyOutput
void SetupEmptyOutput() override
Initialize current output.
vtkXMLTableReader::Piece
int Piece
The piece currently being read.
Definition: vtkXMLTableReader.h:187
vtkXMLTableReader::ReadPiece
int ReadPiece(vtkXMLDataElement *ePiece)
Setup the current piece reader.
vtkX3D::port
@ port
Definition: vtkX3D.h:447
vtkXMLTableReader::NumberOfColumns
int NumberOfColumns
The number of columns arrays in the output.
Definition: vtkXMLTableReader.h:198
vtkXMLTableReader::RowDataElements
vtkXMLDataElement ** RowDataElements
The RowData element representations for each piece.
Definition: vtkXMLTableReader.h:192
vtkXMLTableReader::RowDataNeedToReadTimeStep
int RowDataNeedToReadTimeStep(vtkXMLDataElement *eNested)
Specify the last time step read, useful to know if we need to read data.
vtkXMLTableReader::TotalNumberOfRows
vtkIdType TotalNumberOfRows
Definition: vtkXMLTableReader.h:170
vtkXMLTableReader::RowDataOffset
vtkTypeInt64 * RowDataOffset
Definition: vtkXMLTableReader.h:201
vtkXMLTableReader::SetupNextPiece
void SetupNextPiece()
Initialize the index of the first row to be read in the next piece.
vtkXMLTableReader::SetupUpdateExtent
void SetupUpdateExtent(int piece, int numberOfPieces)
Setup the reader as if the given update extent were requested by its output.
vtkXMLTableReader::SetupOutputTotals
void SetupOutputTotals()
Initialize the total number of rows to be read.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkXMLTableReader
Read VTK XML Table files.
Definition: vtkXMLTableReader.h:39
vtkXMLTableReader::GetOutputUpdateExtent
void GetOutputUpdateExtent(int &piece, int &numberOfPieces)
Get the current piece index and the total number of piece in the dataset.
vtkXMLTableReader::RowElements
vtkXMLDataElement ** RowElements
The Points element for each piece.
Definition: vtkXMLTableReader.h:176
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:51
vtkXMLTableReader::ReadPiece
int ReadPiece(vtkXMLDataElement *ePiece, int piece)
Setup the piece reader at the given index.
vtkXMLTableReader::RowDataTimeStep
int * RowDataTimeStep
Definition: vtkXMLTableReader.h:200
vtkXMLTableReader::DestroyPieces
void DestroyPieces()
vtkXMLDataElement
Represents an XML element and those nested inside.
Definition: vtkXMLDataElement.h:37
vtkXMLTableReader::CopyOutputInformation
void CopyOutputInformation(vtkInformation *outInfo, int port) override
For the specified port, copy the information this reader sets up in SetupOutputInformation to outInfo...
vtkXMLTableReader::NumberOfRows
vtkIdType * NumberOfRows
Definition: vtkXMLTableReader.h:177
vtkXMLTableReader::StartPoint
vtkIdType StartPoint
Definition: vtkXMLTableReader.h:171
vtkXMLTableReader::StartPiece
int StartPiece
The range of pieces from the file that will form the UpdatedPiece.
Definition: vtkXMLTableReader.h:168
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkXMLTableReader::ReadXMLData
void ReadXMLData() override
Pipeline execute data driver.
vtkXMLTableReader::ReadPrimaryElement
int ReadPrimaryElement(vtkXMLDataElement *ePrimary) override
Pipeline execute data driver.
vtkXMLTableReader::UpdateNumberOfPieces
int UpdateNumberOfPieces
Definition: vtkXMLTableReader.h:164
vtkXMLTableReader::GetNumberOfPieces
vtkIdType GetNumberOfPieces()
Get the number of pieces in the file.
vtkIdTypeArray
dynamic, self-adjusting array of vtkIdType
Definition: vtkIdTypeArray.h:42
vtkXMLTableReader::ColumnIsEnabled
int ColumnIsEnabled(vtkXMLDataElement *eRowData)
Check whether the given array element is an enabled array.
vtkXMLTableReader::vtkXMLTableReader
vtkXMLTableReader()
vtkXMLTableReader::SetupOutputData
void SetupOutputData() override
Initialize current output data: allocate arrays for RowData.
vtkXMLTableReader::EndPiece
int EndPiece
Definition: vtkXMLTableReader.h:169
vtkXMLTableReader::SetupPieces
void SetupPieces(int numPieces)
Setup the number of pieces to be read and allocate space accordingly.
vtkXMLTableReader::ReadPieceData
int ReadPieceData(int)
Actually read the current piece data.
vtkXMLReader
Superclass for VTK's XML format readers.
Definition: vtkXMLReader.h:44
vtkXMLTableReader::FillOutputPortInformation
int FillOutputPortInformation(int, vtkInformation *) override
Fill the output port information objects for this algorithm.