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 =========================================================================*/
33 #ifndef vtkXdmf3Reader_h
34 #define vtkXdmf3Reader_h
35 
36 #include "vtkIOXdmf3Module.h" // For export macro
37 #include "vtkDataObjectAlgorithm.h"
38 
40 class vtkGraph;
41 
42 class VTKIOXDMF3_EXPORT vtkXdmf3Reader : public vtkDataObjectAlgorithm
43 {
44 public:
45  static vtkXdmf3Reader* New();
47  void PrintSelf(ostream& os, vtkIndent indent) override;
48 
52  void SetFileName(const char* filename);
53 
55 
60  virtual void AddFileName(const char* filename);
61  virtual void RemoveAllFileNames();
63 
65 
70  vtkSetMacro(FileSeriesAsTime, bool);
71  vtkGetMacro(FileSeriesAsTime, bool);
73 
77  virtual int CanReadFile(const char* filename);
78 
85 
90  const char* GetPointArrayName(int index);
91 
93 
96  int GetPointArrayStatus(const char* name);
97  void SetPointArrayStatus(const char* name, int status);
99 
101 
107  const char* GetCellArrayName(int index);
108  void SetCellArrayStatus(const char* name, int status);
109  int GetCellArrayStatus(const char* name);
111 
113 
119  const char* GetFieldArrayName(int index);
120  void SetFieldArrayStatus(const char* name, int status);
121  int GetFieldArrayStatus(const char* name);
123 
125 
131  const char* GetGridName(int index);
132  void SetGridStatus(const char* gridname, int status);
133  int GetGridStatus(const char* gridname);
135 
137 
144  const char* GetSetName(int index);
145  void SetSetStatus(const char* gridname, int status);
146  int GetSetStatus(const char* gridname);
148 
152  int GetNumberOfSetArrays() { return this->GetNumberOfSets(); }
153  const char* GetSetArrayName(int index)
154  { return this->GetSetName(index); }
155  int GetSetArrayStatus(const char* name)
156  { return this->GetSetStatus(name); }
157 
162  virtual vtkGraph* GetSIL();
163 
168 
169 protected:
172 
173  const char* FileNameInternal;
174  vtkSetStringMacro(FileNameInternal);
175 
176  //Overridden to announce that we make general DataObjects.
178 
179  //Overridden to handle RDO requests the way we need to
181  vtkInformationVector *) override;
182 
183  //Overridden to create the correct vtkDataObject subclass for the file.
186 
187  //Overridden to announce temporal information and to participate in
188  //structured extent splitting.
190  vtkInformationVector *) override;
191 
192  //Read the XDMF and HDF input files and fill in vtk data objects.
194  vtkInformationVector *) override;
195 
206 
207 private:
208  vtkXdmf3Reader(const vtkXdmf3Reader&) = delete;
209  void operator=(const vtkXdmf3Reader&) = delete;
210 
211  bool FileSeriesAsTime;
212 
213  class Internals;
214  Internals *Internal;
215 };
216 
217 #endif
vtkXdmf3Reader::GetSIL
virtual vtkGraph * GetSIL()
SIL describes organization of/relationships between classifications eg.
vtkXdmf3Reader::SetPointArrayStatus
void SetPointArrayStatus(const char *name, int status)
vtkXdmf3Reader::FillOutputPortInformation
int FillOutputPortInformation(int port, vtkInformation *info) override
Fill the output port information objects for this algorithm.
vtkXdmf3Reader::RequestDataObjectInternal
virtual int RequestDataObjectInternal(vtkInformationVector *)
vtkXdmf3Reader::GetPointArrayName
const char * GetPointArrayName(int index)
Returns the name of point array at the give index.
vtkXdmf3Reader::AddFileName
virtual void AddFileName(const char *filename)
Add and remove give the reader a list of top level xml files to read.
vtkXdmf3Reader::RequestData
virtual int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
vtkXdmf3ArraySelection
helper to identify requested arrays with
Definition: vtkXdmf3ArraySelection.h:42
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:42
vtkDataObjectAlgorithm
Superclass for algorithms that produce only data object as output.
Definition: vtkDataObjectAlgorithm.h:44
vtkXdmf3Reader::CanReadFile
virtual int CanReadFile(const char *filename)
Determine if the file can be read with this reader.
vtkXdmf3Reader::vtkXdmf3Reader
vtkXdmf3Reader()
vtkXdmf3Reader::RequestInformation
virtual int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
vtkXdmf3Reader::GetCellArrayStatus
int GetCellArrayStatus(const char *name)
vtkXdmf3Reader::ProcessRequest
int ProcessRequest(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
see vtkAlgorithm for details
vtkXdmf3Reader::New
static vtkXdmf3Reader * New()
vtkXdmf3Reader
Reads eXtensible Data Model and Format files.
Definition: vtkXdmf3Reader.h:43
vtkXdmf3Reader::SetsCache
vtkXdmf3ArraySelection * SetsCache
Definition: vtkXdmf3Reader.h:205
vtkXdmf3Reader::GetFieldArraySelection
vtkXdmf3ArraySelection * GetFieldArraySelection()
vtkX3D::port
@ port
Definition: vtkX3D.h:447
vtkXdmf3Reader::GetSetStatus
int GetSetStatus(const char *gridname)
vtkXdmf3Reader::GetFieldArrayStatus
int GetFieldArrayStatus(const char *name)
vtkXdmf3Reader::GetSetName
const char * GetSetName(int index)
vtkXdmf3Reader::GetSetArrayStatus
int GetSetArrayStatus(const char *name)
Definition: vtkXdmf3Reader.h:155
vtkXdmf3Reader::SetCellArrayStatus
void SetCellArrayStatus(const char *name, int status)
vtkXdmf3Reader::GetNumberOfCellArrays
int GetNumberOfCellArrays()
Get information about cell-based arrays.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkXdmf3Reader::GetNumberOfSets
int GetNumberOfSets()
Get/Set information about sets.
vtkXdmf3Reader::~vtkXdmf3Reader
~vtkXdmf3Reader()
vtkXdmf3Reader::PointArraysCache
vtkXdmf3ArraySelection * PointArraysCache
Definition: vtkXdmf3Reader.h:203
vtkXdmf3Reader::FieldArraysCache
vtkXdmf3ArraySelection * FieldArraysCache
Definition: vtkXdmf3Reader.h:201
vtkXdmf3Reader::SetGridStatus
void SetGridStatus(const char *gridname, int status)
vtkXdmf3Reader::GetNumberOfGrids
int GetNumberOfGrids()
Get/Set information about grids.
vtkXdmf3Reader::GetCellArrayName
const char * GetCellArrayName(int index)
vtkXdmf3Reader::GetSetArrayName
const char * GetSetArrayName(int index)
Definition: vtkXdmf3Reader.h:153
vtkX3D::name
@ name
Definition: vtkX3D.h:219
vtkXdmf3Reader::GetGridStatus
int GetGridStatus(const char *gridname)
vtkXdmf3Reader::GridsCache
vtkXdmf3ArraySelection * GridsCache
Definition: vtkXdmf3Reader.h:204
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkXdmf3Reader::FileNameInternal
const char * FileNameInternal
Definition: vtkXdmf3Reader.h:173
vtkX3D::info
@ info
Definition: vtkX3D.h:376
vtkXdmf3Reader::GetSILUpdateStamp
int GetSILUpdateStamp()
Every time the SIL is updated a this will return a different value.
vtkXdmf3Reader::GetNumberOfPointArrays
int GetNumberOfPointArrays()
Get information about point-based arrays.
vtkXdmf3Reader::GetGridsSelection
vtkXdmf3ArraySelection * GetGridsSelection()
vtkXdmf3Reader::GetNumberOfFieldArrays
int GetNumberOfFieldArrays()
Get information about unaligned arrays.
vtkXdmf3Reader::GetGridName
const char * GetGridName(int index)
vtkXdmf3Reader::GetPointArrayStatus
int GetPointArrayStatus(const char *name)
Get/Set the point array status.
vtkXdmf3Reader::RemoveAllFileNames
virtual void RemoveAllFileNames()
vtkXdmf3Reader::GetFieldArrayName
const char * GetFieldArrayName(int index)
vtkDataObjectAlgorithm.h
vtkGraph
Base class for graph data types.
Definition: vtkGraph.h:288
vtkXdmf3Reader::SetFieldArrayStatus
void SetFieldArrayStatus(const char *name, int status)
vtkXdmf3Reader::GetNumberOfSetArrays
int GetNumberOfSetArrays()
These methods are provided to make it easier to use the Sets in ParaView.
Definition: vtkXdmf3Reader.h:152
vtkX3D::index
@ index
Definition: vtkX3D.h:246
vtkXdmf3Reader::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkXdmf3Reader::SetSetStatus
void SetSetStatus(const char *gridname, int status)
vtkXdmf3Reader::GetCellArraySelection
vtkXdmf3ArraySelection * GetCellArraySelection()
vtkXdmf3Reader::GetSetsSelection
vtkXdmf3ArraySelection * GetSetsSelection()
vtkXdmf3Reader::SetFileName
void SetFileName(const char *filename)
Set tells the reader the name of a single top level xml file to read.
vtkXdmf3Reader::GetPointArraySelection
vtkXdmf3ArraySelection * GetPointArraySelection()
vtkXdmf3Reader::CellArraysCache
vtkXdmf3ArraySelection * CellArraysCache
Definition: vtkXdmf3Reader.h:202