VTK
vtkXMLPDataReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkXMLPDataReader.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 vtkXMLPDataReader_h
27 #define vtkXMLPDataReader_h
28 
29 #include "vtkIOXMLModule.h" // For export macro
30 #include "vtkXMLReader.h"
31 
32 class vtkDataArray;
33 class vtkDataSet;
34 class vtkXMLDataReader;
35 
37 {
38 public:
40  void PrintSelf(ostream& os, vtkIndent indent);
41 
43 
44  vtkGetMacro(NumberOfPieces, int);
46 
47  // For the specified port, copy the information this reader sets up in
48  // SetupOutputInformation to outInfo
49  virtual void CopyOutputInformation(vtkInformation *outInfo, int port);
50 
51 protected:
54 
55  // Pipeline execute information driver. Called by vtkXMLReader.
57  virtual void SetupOutputInformation(vtkInformation *outInfo);
58 
60 
63 
67  virtual void CopyArrayForPoints(vtkDataArray* inArray,
68  vtkDataArray* outArray)=0;
69  virtual void CopyArrayForCells(vtkDataArray* inArray,
70  vtkDataArray* outArray)=0;
71 
72  virtual void SetupPieces(int numPieces);
73  virtual void DestroyPieces();
74  int ReadPiece(vtkXMLDataElement* ePiece, int index);
75  virtual int ReadPiece(vtkXMLDataElement* ePiece);
76  int ReadPieceData(int index);
77  virtual int ReadPieceData();
78  int CanReadPiece(int index);
79 
80  char* CreatePieceFileName(const char* fileName);
81  void SplitFileName();
82 
83  // Callback registered with the PieceProgressObserver.
84  static void PieceProgressCallbackFunction(vtkObject*, unsigned long, void*,
85  void*);
86  virtual void PieceProgressCallback();
87 
88  // Pieces from the input summary file.
90 
91  // The ghost level available on each input piece.
93 
94  // The piece currently being read.
95  int Piece;
96 
97  // The path to the input file without the file name.
98  char* PathName;
99 
100  // Information per-piece.
104 
105  // The PPointData and PCellData element representations.
108 
109  // The observer to report progress from reading serial data in each
110  // piece.
112 
113 private:
114  vtkXMLPDataReader(const vtkXMLPDataReader&); // Not implemented.
115  void operator=(const vtkXMLPDataReader&); // Not implemented.
116 };
117 
118 #endif
vtkXMLPDataReader::SetupPieces
virtual void SetupPieces(int numPieces)
vtkXMLPDataReader::GetPieceInputAsDataSet
vtkDataSet * GetPieceInputAsDataSet(int piece)
VTKIOXML_EXPORT
#define VTKIOXML_EXPORT
Definition: vtkIOXMLModule.h:15
vtkXMLPDataReader::PieceElements
vtkXMLDataElement ** PieceElements
Definition: vtkXMLPDataReader.h:101
vtkXMLPDataReader::PieceProgressObserver
vtkCallbackCommand * PieceProgressObserver
Definition: vtkXMLPDataReader.h:111
vtkXMLReader.h
vtkIdType
int vtkIdType
Definition: vtkType.h:275
vtkXMLPDataReader::CanReadPiece
int CanReadPiece(int index)
vtkXMLPDataReader::GhostLevel
int GhostLevel
Definition: vtkXMLPDataReader.h:92
vtkXMLPDataReader::GetNumberOfPoints
virtual vtkIdType GetNumberOfPoints()=0
vtkXMLPDataReader::PCellDataElement
vtkXMLDataElement * PCellDataElement
Definition: vtkXMLPDataReader.h:107
vtkTypeMacro
#define vtkTypeMacro(thisClass, superclass)
Definition: vtkSetGet.h:642
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:62
vtkXMLPDataReader::ReadXMLInformation
int ReadXMLInformation()
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
vtkXMLPDataReader::PathName
char * PathName
Definition: vtkXMLPDataReader.h:98
vtkXMLDataReader
Superclass for VTK XML file readers.
Definition: vtkXMLDataReader.h:33
vtkXMLPDataReader::GetNumberOfCells
virtual vtkIdType GetNumberOfCells()=0
vtkXMLPDataReader::PieceProgressCallback
virtual void PieceProgressCallback()
vtkXMLPDataReader::CreatePieceReader
virtual vtkXMLDataReader * CreatePieceReader()=0
vtkXMLPDataReader::~vtkXMLPDataReader
~vtkXMLPDataReader()
vtkIOXMLModule.h
vtkX3D::port
@ port
Definition: vtkX3D.h:447
vtkXMLPDataReader::ReadPrimaryElement
int ReadPrimaryElement(vtkXMLDataElement *ePrimary)
vtkXMLPDataReader::CopyArrayForPoints
virtual void CopyArrayForPoints(vtkDataArray *inArray, vtkDataArray *outArray)=0
vtkXMLPDataReader::PPointDataElement
vtkXMLDataElement * PPointDataElement
Definition: vtkXMLPDataReader.h:106
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkXMLPDataReader::vtkXMLPDataReader
vtkXMLPDataReader()
vtkXMLPDataReader::CopyOutputInformation
virtual void CopyOutputInformation(vtkInformation *outInfo, int port)
vtkXMLPDataReader::ReadPiece
int ReadPiece(vtkXMLDataElement *ePiece, int index)
vtkXMLDataElement
Represents an XML element and those nested inside.
Definition: vtkXMLDataElement.h:36
vtkGetMacro
#define vtkGetMacro(name, type)
Definition: vtkSetGet.h:93
vtkXMLPDataReader::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
vtkXMLPDataReader::PieceReaders
vtkXMLDataReader ** PieceReaders
Definition: vtkXMLPDataReader.h:102
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:62
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
vtkXMLPDataReader::PieceProgressCallbackFunction
static void PieceProgressCallbackFunction(vtkObject *, unsigned long, void *, void *)
vtkgl::index
GLuint index
Definition: vtkgl.h:11983
vtkXMLPDataReader::ReadPieceData
virtual int ReadPieceData()
vtkXMLPDataReader::ReadPiece
virtual int ReadPiece(vtkXMLDataElement *ePiece)
vtkCallbackCommand
supports function callbacks
Definition: vtkCallbackCommand.h:50
vtkXMLPDataReader::ReadPieceData
int ReadPieceData(int index)
vtkXMLPDataReader::CopyArrayForCells
virtual void CopyArrayForCells(vtkDataArray *inArray, vtkDataArray *outArray)=0
vtkXMLPDataReader::DestroyPieces
virtual void DestroyPieces()
vtkXMLPDataReader::NumberOfPieces
int NumberOfPieces
Definition: vtkXMLPDataReader.h:89
vtkXMLPDataReader::SetupOutputData
void SetupOutputData()
vtkXMLPDataReader
Superclass for PVTK XML file readers.
Definition: vtkXMLPDataReader.h:37
vtkXMLPDataReader::CanReadPieceFlag
int * CanReadPieceFlag
Definition: vtkXMLPDataReader.h:103
vtkXMLPDataReader::CreatePieceFileName
char * CreatePieceFileName(const char *fileName)
vtkXMLReader
Superclass for VTK's XML format readers.
Definition: vtkXMLReader.h:42
vtkXMLPDataReader::SplitFileName
void SplitFileName()
vtkXMLPDataReader::Piece
int Piece
Definition: vtkXMLPDataReader.h:95
vtkXMLPDataReader::SetupOutputInformation
virtual void SetupOutputInformation(vtkInformation *outInfo)