VTK
vtkTRUCHASReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkTRUCHASReader.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 =========================================================================*/
26 #ifndef vtkTRUCHASReader_h
27 #define vtkTRUCHASReader_h
28 
29 #include "vtkIOTRUCHASModule.h" // For export macro
31 
33 
34 class VTKIOTRUCHAS_EXPORT vtkTRUCHASReader
36 {
37 public:
38  static vtkTRUCHASReader *New();
40  void PrintSelf(ostream& os, vtkIndent indent) override;
41 
43 
46  vtkSetStringMacro(FileName);
47  vtkGetStringMacro(FileName);
49 
53  static int CanReadFile(const char *filename);
54 
56 
62  const char* GetBlockArrayName(int index);
63  void SetBlockArrayStatus(const char* gridname, int status);
64  int GetBlockArrayStatus(const char* gridname);
66 
73 
78  const char* GetPointArrayName(int index);
79 
81 
84  int GetPointArrayStatus(const char* name);
85  void SetPointArrayStatus(const char* name, int status);
87 
94 
99  const char* GetCellArrayName(int index);
100 
102 
105  int GetCellArrayStatus(const char* name);
106  void SetCellArrayStatus(const char* name, int status);
108 
109 protected:
111  ~vtkTRUCHASReader() override;
112 
117  vtkInformationVector *) override;
122  vtkInformationVector *) override;
123 
124  char *FileName;
125 
126  class Internal;
127  Internal * Internals;
128  friend class Internal;
129 
133 
134 private:
135  vtkTRUCHASReader(const vtkTRUCHASReader&) = delete;
136  void operator=(const vtkTRUCHASReader&) = delete;
137 
138 };
139 
140 #endif
vtkTRUCHASReader::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:42
vtkTRUCHASReader::vtkTRUCHASReader
vtkTRUCHASReader()
vtkTRUCHASReader::CanReadFile
static int CanReadFile(const char *filename)
A simple, non-exhaustive check to see if a file is a valid truchas file.
vtkTRUCHASReader::GetCellArrayStatus
int GetCellArrayStatus(const char *name)
Get/Set the cell array status.
vtkTRUCHASReader::SetBlockArrayStatus
void SetBlockArrayStatus(const char *gridname, int status)
vtkTRUCHASReader::RequestInformation
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Overridden to announce timesteps we can produce.
vtkDataArraySelection
Store on/off settings for data arrays for a vtkSource.
Definition: vtkDataArraySelection.h:38
vtkTRUCHASReader::GetCellArrayName
const char * GetCellArrayName(int index)
Returns the name of cell array at the give index.
vtkTRUCHASReader::PointArrayChoices
vtkDataArraySelection * PointArrayChoices
Definition: vtkTRUCHASReader.h:131
vtkTRUCHASReader::SetCellArrayStatus
void SetCellArrayStatus(const char *name, int status)
vtkTRUCHASReader::FileName
char * FileName
Definition: vtkTRUCHASReader.h:124
vtkTRUCHASReader::SetPointArrayStatus
void SetPointArrayStatus(const char *name, int status)
vtkTRUCHASReader::GetPointArrayName
const char * GetPointArrayName(int index)
Returns the name of point array at the give index.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkTRUCHASReader::GetNumberOfCellArrays
int GetNumberOfCellArrays()
Get information about cell-based arrays.
vtkTRUCHASReader::GetNumberOfBlockArrays
int GetNumberOfBlockArrays()
Get/Set information about blocks.
vtkTRUCHASReader::New
static vtkTRUCHASReader * New()
vtkTRUCHASReader::BlockChoices
vtkDataArraySelection * BlockChoices
Definition: vtkTRUCHASReader.h:130
vtkTRUCHASReader
read GE TRUCHAS format HDF5 files
Definition: vtkTRUCHASReader.h:36
vtkMultiBlockDataSetAlgorithm.h
vtkTRUCHASReader::GetPointArrayStatus
int GetPointArrayStatus(const char *name)
Get/Set the point array status.
vtkX3D::name
@ name
Definition: vtkX3D.h:219
vtkTRUCHASReader::Internals
Internal * Internals
Definition: vtkTRUCHASReader.h:126
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkTRUCHASReader::GetNumberOfPointArrays
int GetNumberOfPointArrays()
Get information about point-based arrays.
vtkTRUCHASReader::RequestData
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Overridden to read the file and parse into an output.
vtkTRUCHASReader::GetBlockArrayName
const char * GetBlockArrayName(int index)
vtkTRUCHASReader::GetBlockArrayStatus
int GetBlockArrayStatus(const char *gridname)
vtkX3D::index
@ index
Definition: vtkX3D.h:246
vtkTRUCHASReader::~vtkTRUCHASReader
~vtkTRUCHASReader() override
vtkTRUCHASReader::CellArrayChoices
vtkDataArraySelection * CellArrayChoices
Definition: vtkTRUCHASReader.h:132
vtkMultiBlockDataSetAlgorithm
Superclass for algorithms that produce only vtkMultiBlockDataSet as output.
Definition: vtkMultiBlockDataSetAlgorithm.h:36