VTK  9.2.6
vtkPassArrays.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPassArrays.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 =========================================================================*/
15 /*-------------------------------------------------------------------------
16  Copyright 2008 Sandia Corporation.
17  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
18  the U.S. Government retains certain rights in this software.
19 -------------------------------------------------------------------------*/
74 #ifndef vtkPassArrays_h
75 #define vtkPassArrays_h
76 
77 #include "vtkDataObjectAlgorithm.h"
78 #include "vtkFiltersGeneralModule.h" // For export macro
79 
80 class VTKFILTERSGENERAL_EXPORT vtkPassArrays : public vtkDataObjectAlgorithm
81 {
82 public:
83  static vtkPassArrays* New();
85  void PrintSelf(ostream& os, vtkIndent indent) override;
86 
93  virtual void AddArray(int fieldType, const char* name);
94 
95  virtual void AddPointDataArray(const char* name);
96  virtual void AddCellDataArray(const char* name);
97  virtual void AddFieldDataArray(const char* name);
98 
99  virtual void RemoveArray(int fieldType, const char* name);
100 
101  virtual void RemovePointDataArray(const char* name);
102  virtual void RemoveCellDataArray(const char* name);
103  virtual void RemoveFieldDataArray(const char* name);
104 
106 
109  virtual void ClearArrays();
110  virtual void ClearPointDataArrays();
111  virtual void ClearCellDataArrays();
112  virtual void ClearFieldDataArrays();
114 
116 
120  vtkSetMacro(RemoveArrays, bool);
121  vtkGetMacro(RemoveArrays, bool);
122  vtkBooleanMacro(RemoveArrays, bool);
124 
126 
131  vtkSetMacro(UseFieldTypes, bool);
132  vtkGetMacro(UseFieldTypes, bool);
133  vtkBooleanMacro(UseFieldTypes, bool);
135 
143  virtual void AddFieldType(int fieldType);
144 
148  virtual void ClearFieldTypes();
149 
154  vtkInformationVector* outputVector) override;
155 
156 protected:
157  vtkPassArrays();
158  ~vtkPassArrays() override;
159 
164  int FillInputPortInformation(int port, vtkInformation* info) override;
165 
169  int RequestDataObject(vtkInformation* request, vtkInformationVector** inputVector,
170  vtkInformationVector* outputVector) override;
171 
173 
176 
177  class Internals;
178  Internals* Implementation;
179 
180 private:
181  vtkPassArrays(const vtkPassArrays&) = delete;
182  void operator=(const vtkPassArrays&) = delete;
183 };
184 
185 #endif
virtual int RequestDataObject(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called by the superclass.
Store vtkAlgorithm input/output information.
static vtkDataObjectAlgorithm * New()
vtkTypeBool ProcessRequest(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
see vtkAlgorithm for details
int vtkTypeBool
Definition: vtkABI.h:69
Passes a subset of arrays to the output.
Definition: vtkPassArrays.h:80
a simple class to control print indentation
Definition: vtkIndent.h:39
Superclass for algorithms that produce only data object as output.
Internals * Implementation
virtual int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Store zero or more vtkInformation instances.
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.