annotate OrthancServer/Sources/ServerIndexChange.h @ 5850:1980354c8113 find-refactoring

add level of interest to StatelessDatabaseOperations::LookupAttachment()
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 29 Oct 2024 15:03:32 +0000
parents f7adfb22e20e
children
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
5640
f7adfb22e20e updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5485
diff changeset
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium
f7adfb22e20e updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5485
diff changeset
6 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium
5485
48b8dae6dc77 upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5185
diff changeset
7 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 *
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * This program is free software: you can redistribute it and/or
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * modify it under the terms of the GNU General Public License as
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * published by the Free Software Foundation, either version 3 of the
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * License, or (at your option) any later version.
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 *
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * This program is distributed in the hope that it will be useful, but
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * General Public License for more details.
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 *
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * You should have received a copy of the GNU General Public License
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 **/
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #pragma once
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 #include "ServerEnumerations.h"
4045
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
27 #include "../../OrthancFramework/Sources/IDynamicObject.h"
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
28 #include "../../OrthancFramework/Sources/SystemToolbox.h"
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 #include <string>
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
31 #include <json/value.h>
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 namespace Orthanc
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 {
1436
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
35 struct ServerIndexChange : public IDynamicObject
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 {
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 private:
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
38 int64_t seq_;
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 ChangeType changeType_;
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 ResourceType resourceType_;
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 std::string publicId_;
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
42 std::string date_;
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 public:
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 ServerIndexChange(ChangeType changeType,
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 ResourceType resourceType,
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
47 const std::string& publicId) :
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
48 seq_(-1),
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 changeType_(changeType),
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 resourceType_(resourceType),
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
51 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
52 date_(SystemToolbox::GetNowIsoString(true /* use UTC time (not local time) */))
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 {
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 }
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
56 ServerIndexChange(int64_t seq,
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
57 ChangeType changeType,
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
58 ResourceType resourceType,
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
59 const std::string& publicId,
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
60 const std::string& date) :
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
61 seq_(seq),
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
62 changeType_(changeType),
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
63 resourceType_(resourceType),
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
64 publicId_(publicId),
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
65 date_(date)
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
66 {
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
67 }
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
68
1436
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
69 ServerIndexChange(const ServerIndexChange& other)
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
70 : seq_(other.seq_),
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
71 changeType_(other.changeType_),
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
72 resourceType_(other.resourceType_),
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
73 publicId_(other.publicId_),
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
74 date_(other.date_)
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
75 {
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
76 }
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
77
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
78 ServerIndexChange* Clone() const
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
79 {
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
80 return new ServerIndexChange(*this);
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
81 }
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
82
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
83 int64_t GetSeq() const
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
84 {
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
85 return seq_;
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
86 }
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
87
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 ChangeType GetChangeType() const
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 {
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 return changeType_;
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 }
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 ResourceType GetResourceType() const
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 {
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 return resourceType_;
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 }
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98 const std::string& GetPublicId() const
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 {
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 return publicId_;
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 }
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
102
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
103 const std::string& GetDate() const
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
104 {
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
105 return date_;
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
106 }
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
107
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
108 void Format(Json::Value& item) const
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
109 {
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
110 item = Json::objectValue;
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
111 item["Seq"] = static_cast<int>(seq_);
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
112 item["ChangeType"] = EnumerationToString(changeType_);
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
113 item["ResourceType"] = EnumerationToString(resourceType_);
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
114 item["ID"] = publicId_;
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
115 item["Path"] = GetBasePath(resourceType_, publicId_);
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
116 item["Date"] = date_;
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
117 }
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 };
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119 }