VTK  9.2.6
vtkArrayRename.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkArrayRename.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
27
28#ifndef vtkArrayRename_h
29#define vtkArrayRename_h
30
31#include "vtkFiltersCoreModule.h" // For export macro
33
34#include "vtkDataObject.h" // for AttributeTypes enum
35
36#include <map> // for std::map
37#include <string> // for std::string
38
39class VTKFILTERSCORE_EXPORT vtkArrayRename : public vtkPassInputTypeAlgorithm
40{
41public:
44 void PrintSelf(ostream& os, vtkIndent indent) override;
45
50
53 int GetNumberOfArrays(int attributeType);
57 const char* GetArrayOriginalName(int attributeType, int idx);
61 const char* GetArrayNewName(int attributeType, int idx);
65 void SetArrayName(int attributeType, int idx, const char* newName);
69 void SetArrayName(int attributeType, const char* inputName, const char* newName);
73 void ClearMapping(int attributeType);
75
83 const char* GetPointArrayOriginalName(int idx)
84 {
86 }
87 const char* GetPointArrayNewName(int idx)
88 {
89 return this->GetArrayNewName(vtkDataObject::POINT, idx);
90 }
91 void SetPointArrayName(int idx, const char* newName)
92 {
93 this->SetArrayName(vtkDataObject::POINT, idx, newName);
94 }
95 void SetPointArrayName(const char* inputName, const char* newName)
96 {
97 this->SetArrayName(vtkDataObject::POINT, inputName, newName);
98 }
101
109 const char* GetCellArrayOriginalName(int idx)
110 {
111 return this->GetArrayOriginalName(vtkDataObject::CELL, idx);
112 }
113 const char* GetCellArrayNewName(int idx)
114 {
115 return this->GetArrayNewName(vtkDataObject::CELL, idx);
116 }
117 void SetCellArrayName(int idx, const char* newName)
118 {
119 this->SetArrayName(vtkDataObject::CELL, idx, newName);
120 }
121 void SetCellArrayName(const char* inputName, const char* newName)
122 {
123 this->SetArrayName(vtkDataObject::CELL, inputName, newName);
124 }
127
135 const char* GetFieldArrayOriginalName(int idx)
136 {
138 }
139 const char* GetFieldArrayNewName(int idx)
140 {
141 return this->GetArrayNewName(vtkDataObject::FIELD, idx);
142 }
143 void SetFieldArrayName(int idx, const char* newName)
144 {
145 this->SetArrayName(vtkDataObject::FIELD, idx, newName);
146 }
147 void SetFieldArrayName(const char* inputName, const char* newName)
148 {
149 this->SetArrayName(vtkDataObject::FIELD, inputName, newName);
150 }
153
161 const char* GetVertexArrayOriginalName(int idx)
162 {
164 }
165 const char* GetVertexArrayNewName(int idx)
166 {
167 return this->GetArrayNewName(vtkDataObject::VERTEX, idx);
168 }
169 void SetVertexArrayName(int idx, const char* newName)
170 {
171 this->SetArrayName(vtkDataObject::VERTEX, idx, newName);
172 }
173 void SetVertexArrayName(const char* inputName, const char* newName)
174 {
175 this->SetArrayName(vtkDataObject::VERTEX, inputName, newName);
176 }
179
187 const char* GetEdgeArrayOriginalName(int idx)
188 {
189 return this->GetArrayOriginalName(vtkDataObject::EDGE, idx);
190 }
191 const char* GetEdgeArrayNewName(int idx)
192 {
193 return this->GetArrayNewName(vtkDataObject::EDGE, idx);
194 }
195 void SetEdgeArrayName(int idx, const char* newName)
196 {
197 this->SetArrayName(vtkDataObject::EDGE, idx, newName);
198 }
199 void SetEdgeArrayName(const char* inputName, const char* newName)
200 {
201 this->SetArrayName(vtkDataObject::EDGE, inputName, newName);
202 }
205
213 const char* GetRowArrayOriginalName(int idx)
214 {
215 return this->GetArrayOriginalName(vtkDataObject::ROW, idx);
216 }
217 const char* GetRowArrayNewName(int idx) { return this->GetArrayNewName(vtkDataObject::ROW, idx); }
218 void SetRowArrayName(int idx, const char* newName)
219 {
220 this->SetArrayName(vtkDataObject::ROW, idx, newName);
221 }
222 void SetRowArrayName(const char* inputName, const char* newName)
223 {
224 this->SetArrayName(vtkDataObject::ROW, inputName, newName);
225 }
228
232 void ClearAll();
233
234protected:
235 vtkArrayRename() = default;
236 ~vtkArrayRename() override = default;
237
239
240 int FillInputPortInformation(int port, vtkInformation* info) override;
241
242private:
243 vtkArrayRename(const vtkArrayRename&) = delete;
244 void operator=(const vtkArrayRename&) = delete;
245
246 std::map<int, std::map<std::string, std::string>> ArrayMapping;
247};
248
249#endif // vtkArrayRename_h
void SetArrayName(int attributeType, int idx, const char *newName)
Set the new array name from idx in attributeType field data.
void SetPointArrayName(const char *inputName, const char *newName)
Get / Set array name mapping for PointData.
void ClearPointMapping()
Get / Set array name mapping for PointData.
int GetNumberOfVertexArrays()
Get / Set array name mapping for VertexData.
const char * GetEdgeArrayOriginalName(int idx)
Get / Set array name mapping for EdgeData.
~vtkArrayRename() override=default
void ClearRowMapping()
Get / Set array name mapping for RowData.
const char * GetPointArrayOriginalName(int idx)
Get / Set array name mapping for PointData.
void SetArrayName(int attributeType, const char *inputName, const char *newName)
Set the new array name from inputName in attributeType field data.
void ClearCellMapping()
Get / Set array name mapping for CellData.
int GetNumberOfArrays(int attributeType)
Set / Get array name mapping for specified attribute type.
void SetVertexArrayName(int idx, const char *newName)
Get / Set array name mapping for VertexData.
const char * GetVertexArrayOriginalName(int idx)
Get / Set array name mapping for VertexData.
void ClearFieldMapping()
Get / Set array name mapping for FieldData.
void SetEdgeArrayName(int idx, const char *newName)
Get / Set array name mapping for EdgeData.
int GetNumberOfEdgeArrays()
Get / Set array name mapping for EdgeData.
const char * GetRowArrayNewName(int idx)
Get / Set array name mapping for RowData.
const char * GetRowArrayOriginalName(int idx)
Get / Set array name mapping for RowData.
void SetVertexArrayName(const char *inputName, const char *newName)
Get / Set array name mapping for VertexData.
void SetEdgeArrayName(const char *inputName, const char *newName)
Get / Set array name mapping for EdgeData.
int GetNumberOfFieldArrays()
Get / Set array name mapping for FieldData.
const char * GetEdgeArrayNewName(int idx)
Get / Set array name mapping for EdgeData.
vtkArrayRename()=default
void SetPointArrayName(int idx, const char *newName)
Get / Set array name mapping for PointData.
void SetFieldArrayName(const char *inputName, const char *newName)
Get / Set array name mapping for FieldData.
const char * GetPointArrayNewName(int idx)
Get / Set array name mapping for PointData.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int GetNumberOfRowArrays()
Get / Set array name mapping for RowData.
const char * GetCellArrayOriginalName(int idx)
Get / Set array name mapping for CellData.
const char * GetCellArrayNewName(int idx)
Get / Set array name mapping for CellData.
int GetNumberOfCellArrays()
Get / Set array name mapping for CellData.
void ClearVertexMapping()
Get / Set array name mapping for VertexData.
const char * GetFieldArrayNewName(int idx)
Get / Set array name mapping for FieldData.
const char * GetArrayOriginalName(int attributeType, int idx)
Get the input array name from idx in attributeType field data.
void ClearMapping(int attributeType)
Clear mapping for the specified attribute type.
void SetRowArrayName(int idx, const char *newName)
Get / Set array name mapping for RowData.
void SetCellArrayName(const char *inputName, const char *newName)
Get / Set array name mapping for CellData.
void ClearEdgeMapping()
Get / Set array name mapping for EdgeData.
int GetNumberOfPointArrays()
Get / Set array name mapping for PointData.
const char * GetArrayNewName(int attributeType, int idx)
Get the new array name from idx in attributeType field data.
const char * GetFieldArrayOriginalName(int idx)
Get / Set array name mapping for FieldData.
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
void ClearAll()
Clear name mappings for all attribute types.
const char * GetVertexArrayNewName(int idx)
Get / Set array name mapping for VertexData.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when a request asks the algorithm to do its work.
void SetCellArrayName(int idx, const char *newName)
Get / Set array name mapping for CellData.
void SetFieldArrayName(int idx, const char *newName)
Get / Set array name mapping for FieldData.
static vtkArrayRename * New()
void SetRowArrayName(const char *inputName, const char *newName)
Get / Set array name mapping for RowData.
a simple class to control print indentation
Definition vtkIndent.h:34
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.