VTK
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 "vtkIOXdmf3Module.h" // For export macro
34 #include "vtkDataReader.h"
35 
37 
38 class VTKIOXDMF3_EXPORT vtkXdmf3Reader : public vtkDataReader
39 {
40 public:
41  static vtkXdmf3Reader* New();
42  vtkTypeMacro(vtkXdmf3Reader, vtkDataReader);
43  void PrintSelf(ostream& os, vtkIndent indent) override;
44 
48  void SetFileName(const char* filename) override;
49 
51 
56  virtual void AddFileName(const char* filename);
57  virtual void RemoveAllFileNames();
59 
61 
66  vtkSetMacro(FileSeriesAsTime, bool);
67  vtkGetMacro(FileSeriesAsTime, bool);
69 
73  virtual int CanReadFile(const char* filename);
74 
80  int GetNumberOfPointArrays();
81 
86  const char* GetPointArrayName(int index);
87 
89 
92  int GetPointArrayStatus(const char* name);
93  void SetPointArrayStatus(const char* name, int status);
95 
97 
102  int GetNumberOfCellArrays();
103  const char* GetCellArrayName(int index);
104  void SetCellArrayStatus(const char* name, int status);
105  int GetCellArrayStatus(const char* name);
107 
109 
114  int GetNumberOfFieldArrays();
115  const char* GetFieldArrayName(int index);
116  void SetFieldArrayStatus(const char* name, int status);
117  int GetFieldArrayStatus(const char* name);
119 
121 
126  int GetNumberOfGrids();
127  const char* GetGridName(int index);
128  void SetGridStatus(const char* gridname, int status);
129  int GetGridStatus(const char* gridname);
131 
133 
139  int GetNumberOfSets();
140  const char* GetSetName(int index);
141  void SetSetStatus(const char* gridname, int status);
142  int GetSetStatus(const char* gridname);
144 
148  int GetNumberOfSetArrays() { return this->GetNumberOfSets(); }
149  const char* GetSetArrayName(int index)
150  { return this->GetSetName(index); }
151  int GetSetArrayStatus(const char* name)
152  { return this->GetSetStatus(name); }
153 
158  virtual vtkGraph* GetSIL();
159 
163  int GetSILUpdateStamp();
164 
165 protected:
166  vtkXdmf3Reader();
167  ~vtkXdmf3Reader();
168 
169  //Overridden to announce that we make general DataObjects.
171 
172  //Overridden to handle RDO requests the way we need to
174  vtkInformationVector *) override;
175 
176  //Overridden to create the correct vtkDataObject subclass for the file.
177  virtual int RequestDataObject(
179 
180  //Overridden to announce temporal information and to participate in
181  //structured extent splitting.
183  vtkInformationVector *) override;
184 
185  //Read the XDMF and HDF input files and fill in vtk data objects.
187  vtkInformationVector *) override;
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
vtkDataReader::ProcessRequest
int ProcessRequest(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Upstream/Downstream requests form the generalized interface through which executives invoke a algorit...
vtkDataReader
helper superclass for objects that read vtk data files
Definition: vtkDataReader.h:49
vtkXdmf3ArraySelection
helper to identify requested arrays with
Definition: vtkXdmf3ArraySelection.h:40
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:35
vtkDataReader::RequestData
virtual int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Definition: vtkDataReader.h:540
vtkDataReader::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkDataReader::RequestInformation
virtual int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Definition: vtkDataReader.h:546
vtkXdmf3Reader
Reads eXtensible Data Model and Format files.
Definition: vtkXdmf3Reader.h:38
vtkXdmf3Reader::SetsCache
vtkXdmf3ArraySelection * SetsCache
Definition: vtkXdmf3Reader.h:198
vtkX3D::port
Definition: vtkX3D.h:447
vtkDataReader.h
vtkXdmf3Reader::GetSetArrayStatus
int GetSetArrayStatus(const char *name)
Definition: vtkXdmf3Reader.h:151
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkDataReader::New
static vtkDataReader * New()
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:149
vtkX3D::name
Definition: vtkX3D.h:219
vtkXdmf3Reader::GridsCache
vtkXdmf3ArraySelection * GridsCache
Definition: vtkXdmf3Reader.h:197
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:80
vtkX3D::info
Definition: vtkX3D.h:376
vtkGraph
Base class for graph data types.
Definition: vtkGraph.h:281
vtkXdmf3Reader::GetNumberOfSetArrays
int GetNumberOfSetArrays()
These methods are provided to make it easier to use the Sets in ParaView.
Definition: vtkXdmf3Reader.h:148
vtkX3D::index
Definition: vtkX3D.h:246
vtkAlgorithm::FillOutputPortInformation
virtual int FillOutputPortInformation(int port, vtkInformation *info)
Fill the output port information objects for this algorithm.
vtkDataReader::SetFileName
virtual void SetFileName(const char *)
Specify file name of vtk data file to read.
vtkXdmf3Reader::CellArraysCache
vtkXdmf3ArraySelection * CellArraysCache
Definition: vtkXdmf3Reader.h:195