VTK  9.0.2
vtkXdmf3ArraySelection.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkXdmf3ArraySelection.h
5  Language: C++
6 
7  Copyright (c) 1993-2002 Ken Martin, Will Schroeder, Bill Lorensen
8  All rights reserved.
9  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
10 
11  This software is distributed WITHOUT ANY WARRANTY; without even
12  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
13  PURPOSE. See the above copyright notice for more information.
14 
15 =========================================================================*/
28 #ifndef vtkXdmf3ArraySelection_h
29 #define vtkXdmf3ArraySelection_h
30 
31 #include "vtkIOXdmf3Module.h" // For export macro
32 
33 #include <map> //for superclass template
34 #include <string> //for superclass's content type
35 
36 #ifdef _MSC_VER
37 #pragma warning(push) // save
38 #pragma warning(disable : 4251) // needs to have dll-interface to be used by clients of class
39 #endif
40 class VTKIOXDMF3_EXPORT vtkXdmf3ArraySelection : public std::map<std::string, bool>
41 {
42 public:
46  void Merge(const vtkXdmf3ArraySelection& other);
47 
51  void AddArray(const char* name, bool status = true);
52 
56  bool ArrayIsEnabled(const char* name);
57 
61  bool HasArray(const char* name);
62 
64 
67  void SetArrayStatus(const char* name, bool status);
68  int GetArraySetting(const char* name);
70 
74  const char* GetArrayName(int index);
75 
80 };
81 #ifdef _MSC_VER
82 #pragma warning(pop) // restore
83 #endif
84 
85 #endif //# vtkXdmf3ArraySelection_h
86 // VTK-HeaderTest-Exclude: vtkXdmf3ArraySelection.h
helper to identify requested arrays with
void SetArrayStatus(const char *name, bool status)
get/set user choice of whether a particular array is to be loaded
const char * GetArrayName(int index)
get string name of a particular array
void AddArray(const char *name, bool status=true)
add a new array to the set, with a particular status
int GetNumberOfArrays()
get number of arrays in the set
int GetArraySetting(const char *name)
bool HasArray(const char *name)
check if a particular array is in the set yet or not
void Merge(const vtkXdmf3ArraySelection &other)
used in parallel to send of combine sets
bool ArrayIsEnabled(const char *name)
test if a particular array is enablled or not
@ name
Definition: vtkX3D.h:225
@ index
Definition: vtkX3D.h:252