VTK  9.3.1
vtkSimpleReader.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
9 #ifndef vtkSimpleReader_h
10 #define vtkSimpleReader_h
11 
12 #include "vtkCommonExecutionModelModule.h" // For export macro
13 #include "vtkReaderAlgorithm.h"
14 
15 #include <string> // needed for std::string in the interface
16 
17 VTK_ABI_NAMESPACE_BEGIN
18 struct vtkSimpleReaderInternal;
19 
20 class VTKCOMMONEXECUTIONMODEL_EXPORT vtkSimpleReader : public vtkReaderAlgorithm
21 {
22 public:
24  void PrintSelf(ostream& os, vtkIndent indent) override;
25 
32  void AddFileName(VTK_FILEPATH const char* fname);
33 
37  void ClearFileNames();
38 
42  int GetNumberOfFileNames() const;
43 
47  VTK_FILEPATH const char* GetFileName(int i) const;
48 
53  VTK_FILEPATH const char* GetCurrentFileName() const;
54 
56 
61  int ReadTimeDependentMetaData(int timestep, vtkInformation* metadata) override;
62  int ReadMetaData(vtkInformation* metadata) override;
63  int ReadMesh(int piece, int npieces, int nghosts, int timestep, vtkDataObject* output) override;
64  int ReadPoints(int piece, int npieces, int nghosts, int timestep, vtkDataObject* output) override;
65  int ReadArrays(int piece, int npieces, int nghosts, int timestep, vtkDataObject* output) override;
67 
76  virtual double GetTimeValue(VTK_FILEPATH const std::string& fname);
77 
83  virtual int ReadMetaDataSimple(
84  VTK_FILEPATH const std::string& /*fname*/, vtkInformation* /*metadata*/)
85  {
86  return 1;
87  }
88 
95  virtual int ReadMeshSimple(VTK_FILEPATH const std::string& fname, vtkDataObject* output) = 0;
96 
103  virtual int ReadPointsSimple(VTK_FILEPATH const std::string& fname, vtkDataObject* output) = 0;
104 
111  virtual int ReadArraysSimple(VTK_FILEPATH const std::string& fname, vtkDataObject* output) = 0;
112 
113 protected:
114  vtkSimpleReader();
115  ~vtkSimpleReader() override;
116 
119 
120 private:
121  vtkSimpleReader(const vtkSimpleReader&) = delete;
122  void operator=(const vtkSimpleReader&) = delete;
123 
124  vtkSimpleReaderInternal* Internal;
125 };
126 
127 VTK_ABI_NAMESPACE_END
128 #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:28
Superclass for algorithms that are not time or parallel aware.
virtual int ReadMetaDataSimple(VTK_FILEPATH const std::string &, vtkInformation *)
A subclass can override this method to provide meta data specific to a particular file...
virtual int ReadArrays(int piece, int npieces, int nghosts, int timestep, vtkDataObject *output)=0
Read all the arrays (point, cell, field etc.).
virtual int ReadTimeDependentMetaData(int, vtkInformation *)
Provide meta-data for the pipeline.
#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:54
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.