File: vtkInformationKeyLookup.h

package info (click to toggle)
paraview 5.11.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 497,236 kB
  • sloc: cpp: 3,171,290; ansic: 1,315,072; python: 134,290; xml: 103,324; sql: 65,887; sh: 5,286; javascript: 4,901; yacc: 4,383; java: 3,977; perl: 2,363; lex: 1,909; f90: 1,255; objc: 143; makefile: 119; tcl: 59; pascal: 50; fortran: 29
file content (80 lines) | stat: -rw-r--r-- 2,493 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkInformationKeyLookup.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/

/**
 * @class   vtkInformationKeyLookup
 * @brief   Find vtkInformationKeys from name and
 * location strings.
 */

#ifndef vtkInformationKeyLookup_h
#define vtkInformationKeyLookup_h

#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObject.h"

#include <map>     // For std::map
#include <string>  // For std::string
#include <utility> // For std::pair

VTK_ABI_NAMESPACE_BEGIN
class vtkInformationKey;

class VTKCOMMONCORE_EXPORT vtkInformationKeyLookup : public vtkObject
{
public:
  static vtkInformationKeyLookup* New();
  vtkTypeMacro(vtkInformationKeyLookup, vtkObject);

  /**
   * Lists all known keys.
   */
  void PrintSelf(ostream& os, vtkIndent indent) override;

  /**
   * Find an information key from name and location strings. For example,
   * Find("GUI_HIDE", "vtkAbstractArray") returns vtkAbstractArray::GUI_HIDE.
   * Note that this class only knows about keys in modules that are currently
   * linked to the running executable.
   */
  static vtkInformationKey* Find(const std::string& name, const std::string& location);

protected:
  vtkInformationKeyLookup();
  ~vtkInformationKeyLookup() override;

  friend class vtkInformationKey;

  /**
   * Add a key to the KeyMap. This is done automatically in the
   * vtkInformationKey constructor.
   */
  static void RegisterKey(
    vtkInformationKey* key, const std::string& name, const std::string& location);

private:
  vtkInformationKeyLookup(const vtkInformationKeyLookup&) = delete;
  void operator=(const vtkInformationKeyLookup&) = delete;

  typedef std::pair<std::string, std::string> Identifier; // Location, Name
  typedef std::map<Identifier, vtkInformationKey*> KeyMap;

  // Using a static function / variable here to ensure static initialization
  // works as intended, since key objects are static, too.
  static KeyMap& Keys();
};

VTK_ABI_NAMESPACE_END
#endif // vtkInformationKeyLookup_h