annotate Resources/Orthanc/Databases/DatabaseConstraint.h @ 170:e712ff3eede3

sync
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 06 Nov 2020 17:51:01 +0100
parents 063aa53b5917
children 3236894320d6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
152
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * In addition, as a special exception, the copyright holders of this
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * program give permission to link the code of its release with the
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * the linked executables. You must obey the GNU General Public License
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * in all respects for all of the code used other than "OpenSSL". If you
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * your version of the file(s), but you are not obligated to do so. If
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * you do not wish to do so, delete this exception statement from your
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * version. If you delete this exception statement from all source files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * in the program, then also delete it here.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 *
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #pragma once
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 #if !defined(ORTHANC_BUILDING_SERVER_LIBRARY)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 # error Macro ORTHANC_BUILDING_SERVER_LIBRARY must be defined
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 #if ORTHANC_BUILDING_SERVER_LIBRARY == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 # include "../../../OrthancFramework/Sources/DicomFormat/DicomMap.h"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 #else
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 // This is for the "orthanc-databases" project to reuse this file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 # include <DicomFormat/DicomMap.h>
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 #define ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT 0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 #if ORTHANC_ENABLE_PLUGINS == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 # include <orthanc/OrthancCDatabasePlugin.h>
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 # if defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE) // Macro introduced in 1.3.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 # if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 2)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 # undef ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 # define ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 # endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 # endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 namespace Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 enum ConstraintType
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 ConstraintType_Equal,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 ConstraintType_SmallerOrEqual,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 ConstraintType_GreaterOrEqual,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 ConstraintType_Wildcard,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 ConstraintType_List
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 };
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 namespace Plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 #if ORTHANC_ENABLE_PLUGINS == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 OrthancPluginResourceType Convert(ResourceType type);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 #if ORTHANC_ENABLE_PLUGINS == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 ResourceType Convert(OrthancPluginResourceType type);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 OrthancPluginConstraintType Convert(ConstraintType constraint);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 ConstraintType Convert(OrthancPluginConstraintType constraint);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 // This class is also used by the "orthanc-databases" project
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 class DatabaseConstraint
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 private:
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 ResourceType level_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 DicomTag tag_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 bool isIdentifier_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 ConstraintType constraintType_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98 std::vector<std::string> values_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 bool caseSensitive_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 bool mandatory_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102 public:
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103 DatabaseConstraint(ResourceType level,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104 const DicomTag& tag,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105 bool isIdentifier,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 ConstraintType type,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107 const std::vector<std::string>& values,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 bool caseSensitive,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109 bool mandatory);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1
170
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 152
diff changeset
112 explicit DatabaseConstraint(const OrthancPluginDatabaseConstraint& constraint);
152
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 ResourceType GetLevel() const
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 return level_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
120 const DicomTag& GetTag() const
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
121 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122 return tag_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
123 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
124
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
125 bool IsIdentifier() const
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
126 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
127 return isIdentifier_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
128 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
129
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
130 ConstraintType GetConstraintType() const
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
131 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
132 return constraintType_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
133 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
134
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
135 size_t GetValuesCount() const
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
136 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
137 return values_.size();
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
138 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
139
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
140 const std::string& GetValue(size_t index) const;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
141
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
142 const std::string& GetSingleValue() const;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
143
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
144 bool IsCaseSensitive() const
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
145 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
146 return caseSensitive_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
147 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
148
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
149 bool IsMandatory() const
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
150 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
151 return mandatory_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
152 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
153
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
154 bool IsMatch(const DicomMap& dicom) const;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
155
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
156 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
157 void EncodeForPlugins(OrthancPluginDatabaseConstraint& constraint,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
158 std::vector<const char*>& tmpValues) const;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
159 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
160 };
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
161 }