VTK  9.1.0
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 =========================================================================*/
34 #ifndef vtkFidesReader_h
35 #define vtkFidesReader_h
36 
37 #include "vtkAlgorithm.h"
38 #include "vtkIOFidesModule.h" // For export macro
39 #include <memory> // for std::unique_ptr
40 #include <string> // for std::string
41 
44 
45 class VTKIOFIDES_EXPORT vtkFidesReader : public vtkAlgorithm
46 {
47 public:
53  {
54  OK,
56  EndOfStream
57  };
58 
59  vtkTypeMacro(vtkFidesReader, vtkAlgorithm);
60  void PrintSelf(ostream& os, vtkIndent indent) override;
61 
65  static vtkFidesReader* New();
66 
72 
76  void SetFileName(VTK_FILEPATH const std::string& fname);
77 
79 
87 
94 
99 
108 
116 
118 
124  vtkBooleanMacro(ConvertToVTK, bool);
125  vtkSetMacro(ConvertToVTK, bool);
126  vtkGetMacro(ConvertToVTK, bool);
128 
132  vtkGetObjectMacro(PointDataArraySelection, vtkDataArraySelection);
133 
137  vtkGetObjectMacro(CellDataArraySelection, vtkDataArraySelection);
138 
139 protected:
141  ~vtkFidesReader() override;
142 
143  struct vtkFidesReaderImpl;
144  std::unique_ptr<vtkFidesReaderImpl> Impl;
145 
150 
151  virtual int RequestDataObject(vtkInformation* request, vtkInformationVector** inputVector,
152  vtkInformationVector* outputVector);
153  virtual int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
154  vtkInformationVector* outputVector);
155  virtual int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
156  vtkInformationVector* outputVector);
157 
159 
162 
164 
166 
167 private:
168  vtkFidesReader(const vtkFidesReader&) = delete;
169  void operator=(const vtkFidesReader&) = delete;
170 };
171 
172 #endif
vtkFidesReader::ADIOSAttributeCheck
int ADIOSAttributeCheck(const std::string &name)
vtkFidesReader::SetFileName
void SetFileName(VTK_FILEPATH const std::string &fname)
Set the filename to be read.
vtkFidesReader::NUMBER_OF_BLOCKS
static vtkInformationIntegerKey * NUMBER_OF_BLOCKS()
vtkFidesReader::RequestInformation
virtual int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
vtkFidesReader::ProcessRequest
int ProcessRequest(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Implements various pipeline passes.
VTK_FILEPATH
#define VTK_FILEPATH
Definition: vtkWrappingHints.h:46
vtkFidesReader::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkFidesReader::PointDataArraySelection
vtkDataArraySelection * PointDataArraySelection
Definition: vtkFidesReader.h:160
vtkAlgorithm
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:123
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:145
vtkFidesReader::FillOutputPortInformation
int FillOutputPortInformation(int port, vtkInformation *info) override
Fill the output port information objects for this algorithm.
vtkFidesReader
Read ADIOS2 streams using Fides data model.
Definition: vtkFidesReader.h:46
vtkDataArraySelection
Store on/off settings for data arrays for a vtkSource.
Definition: vtkDataArraySelection.h:35
vtkAlgorithm.h
vtkFidesReader::OK
@ OK
Definition: vtkFidesReader.h:54
vtkFidesReader::~vtkFidesReader
~vtkFidesReader() override
vtkX3D::port
@ port
Definition: vtkX3D.h:453
vtkFidesReader::PrepareNextStep
void PrepareNextStep()
This method has to be called before each step when streaming.
vtkFidesReader::GetNextStepStatus
int GetNextStepStatus()
Get the StepStatus of the next step reported by Fides.
vtkFidesReader::Impl
std::unique_ptr< vtkFidesReaderImpl > Impl
Definition: vtkFidesReader.h:143
vtkInformationIntegerKey
Key for integer values in vtkInformation.
Definition: vtkInformationIntegerKey.h:32
vtkFidesReader::CanReadFile
int CanReadFile(VTK_FILEPATH const std::string &name)
Test whether or not a given file should even be attempted for use with this reader.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:113
vtkFidesReader::CellDataArraySelection
vtkDataArraySelection * CellDataArraySelection
Definition: vtkFidesReader.h:161
vtkFidesReader::SetDataSourcePath
void SetDataSourcePath(const std::string &name, VTK_FILEPATH const std::string &path)
Set the path for a Fides data source.
vtkFidesReader::ParseDataModel
void ParseDataModel(VTK_FILEPATH const std::string &fname)
Given a json filename, parse and internally store a data model.
vtkFidesReader::FileName
std::string FileName
Definition: vtkFidesReader.h:146
vtkX3D::name
@ name
Definition: vtkX3D.h:225
vtkFidesReader::New
static vtkFidesReader * New()
Construct a new reader instance.
vtkFidesReader::NextStepStatus
StepStatus NextStepStatus
Definition: vtkFidesReader.h:149
vtkFidesReader::ParseDataModel
void ParseDataModel()
Given a json filename, parse and internally store a data model.
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:183
vtkX3D::info
@ info
Definition: vtkX3D.h:382
vtkX3D::string
@ string
Definition: vtkX3D.h:496
vtkFidesReader::ConvertToVTK
bool ConvertToVTK
Definition: vtkFidesReader.h:147
vtkFidesReader::RequestData
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
vtkFidesReader::StreamSteps
bool StreamSteps
Definition: vtkFidesReader.h:148
vtkFidesReader::StepStatus
StepStatus
When using streaming mode instead of random access, PrepareNextStep receives a step status from Fides...
Definition: vtkFidesReader.h:53
vtkFidesReader::NotReady
@ NotReady
Definition: vtkFidesReader.h:55
vtkFidesReader::RequestDataObject
virtual int RequestDataObject(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
vtkFidesReader::vtkFidesReader
vtkFidesReader()