annotate OrthancServer/Sources/ServerIndexChange.h @ 4831:7053502fbf97

added copyright UCLouvain
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 25 Nov 2021 19:01:11 +0100
parents d9473bd5ed43
children 2e71a08eea15 43e613a7756b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1737
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1288
6e7e5ed91c2d upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1242
diff changeset
4 * Department, University Hospital of Liege, Belgium
4437
d9473bd5ed43 upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
5 * Copyright (C) 2017-2021 Osimis S.A., Belgium
4831
7053502fbf97 added copyright UCLouvain
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
6 * Copyright (C) 2021-2021 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 *
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * This program is free software: you can redistribute it and/or
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * modify it under the terms of the GNU General Public License as
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * published by the Free Software Foundation, either version 3 of the
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * License, or (at your option) any later version.
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 *
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * In addition, as a special exception, the copyright holders of this
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * program give permission to link the code of its release with the
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * OpenSSL project's "OpenSSL" library (or with modified versions of it
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * that use the same license as the "OpenSSL" library), and distribute
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * the linked executables. You must obey the GNU General Public License
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * in all respects for all of the code used other than "OpenSSL". If you
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * modify file(s) with this exception, you may extend this exception to
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * your version of the file(s), but you are not obligated to do so. If
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * you do not wish to do so, delete this exception statement from your
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * version. If you delete this exception statement from all source files
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 * in the program, then also delete it here.
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 *
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * This program is distributed in the hope that it will be useful, but
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * WITHOUT ANY WARRANTY; without even the implied warranty of
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 * General Public License for more details.
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 *
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * You should have received a copy of the GNU General Public License
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 * along with this program. If not, see <http://www.gnu.org/licenses/>.
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 **/
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 #pragma once
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 #include "ServerEnumerations.h"
4045
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
38 #include "../../OrthancFramework/Sources/IDynamicObject.h"
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
39 #include "../../OrthancFramework/Sources/SystemToolbox.h"
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 #include <string>
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
42 #include <json/value.h>
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 namespace Orthanc
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 {
1436
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
46 struct ServerIndexChange : public IDynamicObject
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 {
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 private:
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
49 int64_t seq_;
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 ChangeType changeType_;
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 ResourceType resourceType_;
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 std::string publicId_;
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
53 std::string date_;
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 public:
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 ServerIndexChange(ChangeType changeType,
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 ResourceType resourceType,
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
58 const std::string& publicId) :
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
59 seq_(-1),
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 changeType_(changeType),
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 resourceType_(resourceType),
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
62 publicId_(publicId),
2475
8cc3ca64a534 Orthanc now uses UTC (universal time) instead of local time in its database
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
63 date_(SystemToolbox::GetNowIsoString(true /* use UTC time (not local time) */))
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 {
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 }
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
67 ServerIndexChange(int64_t seq,
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
68 ChangeType changeType,
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
69 ResourceType resourceType,
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
70 const std::string& publicId,
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
71 const std::string& date) :
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
72 seq_(seq),
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
73 changeType_(changeType),
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
74 resourceType_(resourceType),
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
75 publicId_(publicId),
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
76 date_(date)
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
77 {
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
78 }
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
79
1436
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
80 ServerIndexChange(const ServerIndexChange& other)
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
81 : seq_(other.seq_),
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
82 changeType_(other.changeType_),
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
83 resourceType_(other.resourceType_),
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
84 publicId_(other.publicId_),
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
85 date_(other.date_)
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
86 {
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
87 }
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
88
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
89 ServerIndexChange* Clone() const
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
90 {
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
91 return new ServerIndexChange(*this);
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
92 }
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
93
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
94 int64_t GetSeq() const
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
95 {
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
96 return seq_;
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
97 }
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
98
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 ChangeType GetChangeType() const
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 {
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 return changeType_;
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102 }
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104 ResourceType GetResourceType() const
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105 {
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 return resourceType_;
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107 }
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109 const std::string& GetPublicId() const
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110 {
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111 return publicId_;
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
112 }
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
113
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
114 const std::string& GetDate() const
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
115 {
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
116 return date_;
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
117 }
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
118
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
119 void Format(Json::Value& item) const
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
120 {
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
121 item = Json::objectValue;
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
122 item["Seq"] = static_cast<int>(seq_);
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
123 item["ChangeType"] = EnumerationToString(changeType_);
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
124 item["ResourceType"] = EnumerationToString(resourceType_);
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
125 item["ID"] = publicId_;
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
126 item["Path"] = GetBasePath(resourceType_, publicId_);
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
127 item["Date"] = date_;
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
128 }
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
129 };
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
130 }