VTK  9.3.20240417
vtkTRUCHASReader.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
14 #ifndef vtkTRUCHASReader_h
15 #define vtkTRUCHASReader_h
16 
17 #include "vtkIOTRUCHASModule.h" // For export macro
19 
20 VTK_ABI_NAMESPACE_BEGIN
22 
23 class VTKIOTRUCHAS_EXPORT vtkTRUCHASReader : public vtkMultiBlockDataSetAlgorithm
24 {
25 public:
26  static vtkTRUCHASReader* New();
28  void PrintSelf(ostream& os, vtkIndent indent) override;
29 
31 
37 
41  static int CanReadFile(VTK_FILEPATH const char* filename);
42 
44 
50  const char* GetBlockArrayName(int index);
51  void SetBlockArrayStatus(const char* gridname, int status);
52  int GetBlockArrayStatus(const char* gridname);
54 
61 
66  const char* GetPointArrayName(int index);
67 
69 
72  int GetPointArrayStatus(const char* name);
73  void SetPointArrayStatus(const char* name, int status);
75 
82 
87  const char* GetCellArrayName(int index);
88 
90 
93  int GetCellArrayStatus(const char* name);
94  void SetCellArrayStatus(const char* name, int status);
96 
97 protected:
99  ~vtkTRUCHASReader() override;
100 
109 
110  char* FileName;
111 
112  class Internal;
113  Internal* Internals;
114  friend class Internal;
115 
119 
120 private:
121  vtkTRUCHASReader(const vtkTRUCHASReader&) = delete;
122  void operator=(const vtkTRUCHASReader&) = delete;
123 };
124 
125 VTK_ABI_NAMESPACE_END
126 #endif
Store on/off settings for data arrays, etc.
a simple class to control print indentation
Definition: vtkIndent.h:108
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Superclass for algorithms that produce only vtkMultiBlockDataSet as output.
read GE TRUCHAS format HDF5 files
int GetNumberOfCellArrays()
Get information about cell-based arrays.
void SetBlockArrayStatus(const char *gridname, int status)
Get/Set information about blocks.
const char * GetBlockArrayName(int index)
Get/Set information about blocks.
vtkGetFilePathMacro(FileName)
Specify file name of vtk data file to read.
vtkDataArraySelection * CellArrayChoices
void SetPointArrayStatus(const char *name, int status)
Get/Set the point array status.
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Overridden to announce timesteps we can produce.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Overridden to read the file and parse into an output.
~vtkTRUCHASReader() override
int GetNumberOfPointArrays()
Get information about point-based arrays.
static vtkTRUCHASReader * New()
int GetCellArrayStatus(const char *name)
Get/Set the cell array status.
vtkDataArraySelection * PointArrayChoices
vtkSetFilePathMacro(FileName)
Specify file name of vtk data file to read.
static int CanReadFile(VTK_FILEPATH const char *filename)
A simple, non-exhaustive check to see if a file is a valid truchas file.
const char * GetCellArrayName(int index)
Returns the name of cell array at the give index.
int GetBlockArrayStatus(const char *gridname)
Get/Set information about blocks.
int GetNumberOfBlockArrays()
Get/Set information about blocks.
vtkDataArraySelection * BlockChoices
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int GetPointArrayStatus(const char *name)
Get/Set the point array status.
void SetCellArrayStatus(const char *name, int status)
Get/Set the cell array status.
const char * GetPointArrayName(int index)
Returns the name of point array at the give index.
@ name
Definition: vtkX3D.h:219
@ index
Definition: vtkX3D.h:246
#define VTK_FILEPATH