VTK  9.3.0
vtkADIOS2CoreArraySelection.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 vtkADIOS2CoreArraySelection_h
15 #define vtkADIOS2CoreArraySelection_h
16 
17 #include "vtkIOADIOS2Module.h" // For export macro
18 
19 #include <map> //for superclass template
20 #include <string> //for superclass's content type
21 
22 #ifdef _MSC_VER
23 #pragma warning(push) // save
24 #pragma warning(disable : 4251) // needs to have dll-interface to be used by clients of class
25 #endif
26 VTK_ABI_NAMESPACE_BEGIN
27 class VTKIOADIOS2_EXPORT vtkADIOS2ArraySelection : public std::map<std::string, bool>
28 {
29 public:
33  void AddArray(const char* name, bool status = true);
34 
38  bool ArrayIsEnabled(const char* name);
39 
43  bool HasArray(const char* name);
44 
46 
49  void SetArrayStatus(const char* name, bool status);
50  int GetArrayStatus(const char* name);
52 
56  const char* GetArrayName(int index);
57 
62 };
63 #ifdef _MSC_VER
64 #pragma warning(pop) // restore
65 #endif
66 
67 VTK_ABI_NAMESPACE_END
68 #endif //# vtkADIOS2CoreArraySelection_h
69 // VTK-HeaderTest-Exclude: vtkADIOS2CoreArraySelection.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 name of a particular array
int GetNumberOfArrays()
get number of arrays in the map
bool ArrayIsEnabled(const char *name)
test if a particular array is enablled or not
int GetArrayStatus(const char *name)
get/set user choice of whether a particular array is to be loaded
bool HasArray(const char *name)
check if a particular array is in the map yet or not
void AddArray(const char *name, bool status=true)
add a new array to the set, with a particular status
@ name
Definition: vtkX3D.h:219
@ index
Definition: vtkX3D.h:246