VTK  9.0.1
vtkXdmf3Reader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkXdmf3Reader.h
5  Language: C++
6 
7  Copyright (c) 1993-2002 Ken Martin, Will Schroeder, Bill Lorensen
8  All rights reserved.
9  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
10 
11  This software is distributed WITHOUT ANY WARRANTY; without even
12  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
13  PURPOSE. See the above copyright notice for more information.
14 
15 =========================================================================*/
30 #ifndef vtkXdmf3Reader_h
31 #define vtkXdmf3Reader_h
32 
33 #include "vtkDataObjectAlgorithm.h"
34 #include "vtkIOXdmf3Module.h" // For export macro
35 
37 class vtkGraph;
38 
39 class VTKIOXDMF3_EXPORT vtkXdmf3Reader : public vtkDataObjectAlgorithm
40 {
41 public:
42  static vtkXdmf3Reader* New();
44  void PrintSelf(ostream& os, vtkIndent indent) override;
45 
49  void SetFileName(const char* filename);
50 
52 
57  virtual void AddFileName(const char* filename);
58  virtual void RemoveAllFileNames();
60 
62 
67  vtkSetMacro(FileSeriesAsTime, bool);
68  vtkGetMacro(FileSeriesAsTime, bool);
70 
74  virtual int CanReadFile(const char* filename);
75 
81  int GetNumberOfPointArrays();
82 
87  const char* GetPointArrayName(int index);
88 
90 
93  int GetPointArrayStatus(const char* name);
94  void SetPointArrayStatus(const char* name, int status);
96 
98 
103  int GetNumberOfCellArrays();
104  const char* GetCellArrayName(int index);
105  void SetCellArrayStatus(const char* name, int status);
106  int GetCellArrayStatus(const char* name);
108 
110 
115  int GetNumberOfFieldArrays();
116  const char* GetFieldArrayName(int index);
117  void SetFieldArrayStatus(const char* name, int status);
118  int GetFieldArrayStatus(const char* name);
120 
122 
127  int GetNumberOfGrids();
128  const char* GetGridName(int index);
129  void SetGridStatus(const char* gridname, int status);
130  int GetGridStatus(const char* gridname);
132 
134 
140  int GetNumberOfSets();
141  const char* GetSetName(int index);
142  void SetSetStatus(const char* gridname, int status);
143  int GetSetStatus(const char* gridname);
145 
149  int GetNumberOfSetArrays() { return this->GetNumberOfSets(); }
150  const char* GetSetArrayName(int index) { return this->GetSetName(index); }
151  int GetSetArrayStatus(const char* name) { return this->GetSetStatus(name); }
152 
157  virtual vtkGraph* GetSIL();
158 
162  int GetSILUpdateStamp();
163 
164 protected:
165  vtkXdmf3Reader();
166  ~vtkXdmf3Reader() override;
167 
168  const char* FileNameInternal;
169  vtkSetStringMacro(FileNameInternal);
170 
171  // Overridden to announce that we make general DataObjects.
173 
174  // Overridden to handle RDO requests the way we need to
177 
178  // Overridden to create the correct vtkDataObject subclass for the file.
179  virtual int RequestDataObjectInternal(vtkInformationVector*);
180 
181  // Overridden to announce temporal information and to participate in
182  // structured extent splitting.
183  virtual int RequestInformation(
185 
186  // Read the XDMF and HDF input files and fill in vtk data objects.
188 
189  vtkXdmf3ArraySelection* GetFieldArraySelection();
190  vtkXdmf3ArraySelection* GetCellArraySelection();
191  vtkXdmf3ArraySelection* GetPointArraySelection();
192  vtkXdmf3ArraySelection* GetGridsSelection();
193  vtkXdmf3ArraySelection* GetSetsSelection();
199 
200 private:
201  vtkXdmf3Reader(const vtkXdmf3Reader&) = delete;
202  void operator=(const vtkXdmf3Reader&) = delete;
203 
204  bool FileSeriesAsTime;
205 
206  class Internals;
207  Internals* Internal;
208 };
209 
210 #endif
vtkDataObjectAlgorithm::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkXdmf3ArraySelection
helper to identify requested arrays with
Definition: vtkXdmf3ArraySelection.h:40
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:35
vtkDataObjectAlgorithm
Superclass for algorithms that produce only data object as output.
Definition: vtkDataObjectAlgorithm.h:43
vtkDataObjectAlgorithm::ProcessRequest
vtkTypeBool ProcessRequest(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
see vtkAlgorithm for details
vtkDataObjectAlgorithm::FillOutputPortInformation
int FillOutputPortInformation(int port, vtkInformation *info) override
Fill the output port information objects for this algorithm.
vtkXdmf3Reader
Reads eXtensible Data Model and Format files.
Definition: vtkXdmf3Reader.h:39
vtkXdmf3Reader::SetsCache
vtkXdmf3ArraySelection * SetsCache
Definition: vtkXdmf3Reader.h:198
vtkX3D::port
@ port
Definition: vtkX3D.h:453
vtkXdmf3Reader::GetSetArrayStatus
int GetSetArrayStatus(const char *name)
Definition: vtkXdmf3Reader.h:151
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkXdmf3Reader::PointArraysCache
vtkXdmf3ArraySelection * PointArraysCache
Definition: vtkXdmf3Reader.h:196
vtkXdmf3Reader::FieldArraysCache
vtkXdmf3ArraySelection * FieldArraysCache
Definition: vtkXdmf3Reader.h:194
vtkXdmf3Reader::GetSetArrayName
const char * GetSetArrayName(int index)
Definition: vtkXdmf3Reader.h:150
vtkX3D::name
@ name
Definition: vtkX3D.h:225
vtkXdmf3Reader::GridsCache
vtkXdmf3ArraySelection * GridsCache
Definition: vtkXdmf3Reader.h:197
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:73
vtkXdmf3Reader::FileNameInternal
const char * FileNameInternal
Definition: vtkXdmf3Reader.h:168
vtkX3D::info
@ info
Definition: vtkX3D.h:382
vtkDataObjectAlgorithm::New
static vtkDataObjectAlgorithm * New()
vtkDataObjectAlgorithm::RequestData
virtual int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Definition: vtkDataObjectAlgorithm.h:116
vtkDataObjectAlgorithm.h
vtkGraph
Base class for graph data types.
Definition: vtkGraph.h:289
vtkDataObjectAlgorithm::RequestInformation
virtual int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
vtkXdmf3Reader::GetNumberOfSetArrays
int GetNumberOfSetArrays()
These methods are provided to make it easier to use the Sets in ParaView.
Definition: vtkXdmf3Reader.h:149
vtkX3D::index
@ index
Definition: vtkX3D.h:252
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkXdmf3Reader::CellArraysCache
vtkXdmf3ArraySelection * CellArraysCache
Definition: vtkXdmf3Reader.h:195