VTK  9.2.6
vtkParallelReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkParallelReader.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 vtkParallelReader_h
27 #define vtkParallelReader_h
28 
29 #include "vtkCommonExecutionModelModule.h" // For export macro
30 #include "vtkReaderAlgorithm.h"
31 
32 #include <string> // needed for std::string in the interface
33 
34 struct vtkParallelReaderInternal;
35 
36 class VTKCOMMONEXECUTIONMODEL_EXPORT vtkParallelReader : public vtkReaderAlgorithm
37 {
38 public:
40  void PrintSelf(ostream& os, vtkIndent indent) override;
41 
48  void AddFileName(VTK_FILEPATH const char* fname);
49 
53  void ClearFileNames();
54 
58  int GetNumberOfFileNames() const;
59 
63  VTK_FILEPATH const char* GetFileName(int i) const;
64 
69  VTK_FILEPATH const char* GetCurrentFileName() const;
70 
72 
77  int ReadMetaData(vtkInformation* metadata) override;
78  int ReadMesh(int piece, int npieces, int nghosts, int timestep, vtkDataObject* output) override;
79  int ReadPoints(int piece, int npieces, int nghosts, int timestep, vtkDataObject* output) override;
80  int ReadArrays(int piece, int npieces, int nghosts, int timestep, vtkDataObject* output) override;
82 
83 protected:
85  ~vtkParallelReader() override;
86 
93  virtual double GetTimeValue(const std::string& fname);
94 
101  virtual int ReadMesh(
102  const std::string& fname, int piece, int npieces, int nghosts, vtkDataObject* output) = 0;
103 
110  virtual int ReadPoints(
111  const std::string& fname, int piece, int npieces, int nghosts, vtkDataObject* output) = 0;
112 
119  virtual int ReadArrays(
120  const std::string& fname, int piece, int npieces, int nghosts, vtkDataObject* output) = 0;
121 
123 
124 private:
125  vtkParallelReader(const vtkParallelReader&) = delete;
126  void operator=(const vtkParallelReader&) = delete;
127 
128  vtkParallelReaderInternal* Internal;
129 };
130 
131 #endif
virtual int ReadPoints(int piece, int npieces, int nghosts, int timestep, vtkDataObject *output)=0
Read the points.
std::string GetFileName(const std::string &fileName) noexcept
Set the appropriate file name based on recognized user input.
Store vtkAlgorithm input/output information.
a simple class to control print indentation
Definition: vtkIndent.h:39
virtual int ReadArrays(int piece, int npieces, int nghosts, int timestep, vtkDataObject *output)=0
Read all the arrays (point, cell, field etc.).
Superclass for algorithms that are parallel aware.
#define VTK_FILEPATH
virtual int ReadMesh(int piece, int npieces, int nghosts, int timestep, vtkDataObject *output)=0
Read the mesh (connectivity) for a given set of data partitioning, number of ghost levels and time st...
virtual int ReadMetaData(vtkInformation *metadata)=0
Provide meta-data for the pipeline.
general representation of visualization data
Definition: vtkDataObject.h:65
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
Superclass for readers that implement a simplified API.