Medical Imaging Interaction Toolkit  2023.12.00
Medical Imaging Interaction Toolkit
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
mitkIPropertyDescriptions.h
Go to the documentation of this file.
1 /*============================================================================
2 
3 The Medical Imaging Interaction Toolkit (MITK)
4 
5 Copyright (c) German Cancer Research Center (DKFZ)
6 All rights reserved.
7 
8 Use of this source code is governed by a 3-clause BSD license that can be
9 found in the LICENSE file.
10 
11 ============================================================================*/
12 
13 #ifndef mitkIPropertyDescriptions_h
14 #define mitkIPropertyDescriptions_h
15 
16 #include <MitkCoreExports.h>
17 #include <mitkServiceInterface.h>
18 #include <string>
19 
20 namespace mitk
21 {
30  {
31  public:
32  virtual ~IPropertyDescriptions();
33 
42  virtual bool AddDescription(const std::string &propertyName,
43  const std::string &description,
44  const std::string &className = "",
45  bool overwrite = false) = 0;
46 
55  virtual bool AddDescriptionRegEx(const std::string &propertyRegEx,
56  const std::string &description,
57  const std::string &className = "",
58  bool overwrite = false) = 0;
59 
67  virtual std::string GetDescription(const std::string &propertyName,
68  const std::string &className = "",
69  bool allowNameRegEx = true) const = 0;
70 
78  virtual bool HasDescription(const std::string &propertyName,
79  const std::string &className = "",
80  bool allowNameRegEx = true) const = 0;
81 
86  virtual void RemoveAllDescriptions(const std::string &className = "") = 0;
87 
93  virtual void RemoveDescription(const std::string &propertyName, const std::string &className = "") = 0;
94  };
95 }
96 
97 MITK_DECLARE_SERVICE_INTERFACE(mitk::IPropertyDescriptions, "org.mitk.IPropertyDescriptions")
98 
99 #endif
mitkServiceInterface.h
mitk
Find image slices visible on a given plane.
Definition: RenderingTests.dox:1
MitkCoreExports.h
mitk::IPropertyDescriptions
Interface of property descriptions service.
Definition: mitkIPropertyDescriptions.h:29
MITK_DECLARE_SERVICE_INTERFACE
#define MITK_DECLARE_SERVICE_INTERFACE(IFace, IId)
Definition: mitkServiceInterface.h:26
MITKCORE_EXPORT
#define MITKCORE_EXPORT
Definition: MitkCoreExports.h:15