VTK  9.2.6
vtkFidesReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkFidesReader.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 =========================================================================*/
37 #ifndef vtkFidesReader_h
38 #define vtkFidesReader_h
39 
40 #include "vtkAlgorithm.h"
41 #include "vtkIOFidesModule.h" // For export macro
42 #include <memory> // for std::unique_ptr
43 #include <string> // for std::string
44 
47 
48 class VTKIOFIDES_EXPORT vtkFidesReader : public vtkAlgorithm
49 {
50 public:
56  {
57  OK,
59  EndOfStream
60  };
61 
62  vtkTypeMacro(vtkFidesReader, vtkAlgorithm);
63  void PrintSelf(ostream& os, vtkIndent indent) override;
64 
68  static vtkFidesReader* New();
69 
74  int CanReadFile(VTK_FILEPATH const std::string& name);
75 
79  void SetFileName(VTK_FILEPATH const std::string& fname);
80 
82 
87  void ParseDataModel(VTK_FILEPATH const std::string& fname);
88  void ParseDataModel();
90 
96  void SetDataSourcePath(const std::string& name, VTK_FILEPATH const std::string& path);
97 
104  void SetDataSourceIO(const std::string& name, const std::string& ioAddress);
105 
110 
118  void PrepareNextStep();
119 
126  int GetNextStepStatus();
127 
132  double GetTimeOfCurrentStep();
133 
135 
141  vtkBooleanMacro(ConvertToVTK, bool);
142  vtkSetMacro(ConvertToVTK, bool);
143  vtkGetMacro(ConvertToVTK, bool);
145 
149  vtkGetObjectMacro(PointDataArraySelection, vtkDataArraySelection);
150 
154  vtkGetObjectMacro(CellDataArraySelection, vtkDataArraySelection);
155 
156 protected:
157  vtkFidesReader();
158  ~vtkFidesReader() override;
159 
160  struct vtkFidesReaderImpl;
161  std::unique_ptr<vtkFidesReaderImpl> Impl;
162 
167 
168  virtual int RequestDataObject(vtkInformation* request, vtkInformationVector** inputVector,
169  vtkInformationVector* outputVector);
170  virtual int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
171  vtkInformationVector* outputVector);
172  virtual int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
173  vtkInformationVector* outputVector);
174 
176 
179 
180  static vtkInformationIntegerKey* NUMBER_OF_BLOCKS();
181 
182  int ADIOSAttributeCheck(const std::string& name);
183 
184 private:
185  vtkFidesReader(const vtkFidesReader&) = delete;
186  void operator=(const vtkFidesReader&) = delete;
187 };
188 
189 #endif
StepStatus NextStepStatus
Store vtkAlgorithm input/output information.
vtkDataArraySelection * CellDataArraySelection
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
StepStatus
When using streaming mode instead of random access, PrepareNextStep receives a step status from Fides...
virtual vtkTypeBool ProcessRequest(vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
Upstream/Downstream requests form the generalized interface through which executives invoke a algorit...
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:62
virtual int FillOutputPortInformation(int port, vtkInformation *info)
Fill the output port information objects for this algorithm.
a simple class to control print indentation
Definition: vtkIndent.h:39
Key for integer values in vtkInformation.
Store on/off settings for data arrays, etc.
std::string FileName
std::unique_ptr< vtkFidesReaderImpl > Impl
#define VTK_FILEPATH
Store zero or more vtkInformation instances.
Read ADIOS2 streams using Fides data model.
static vtkAlgorithm * New()
vtkDataArraySelection * PointDataArraySelection