annotate OrthancServer/Sources/ServerIndexChange.h @ 5102:071e1faee1c1

added orthanc framework 1.11.2
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 27 Oct 2022 10:48:41 +0200
parents 6eff25f70121
children 0ea402b4d901
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
4870
43e613a7756b upgrade to year 2022
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4831
diff changeset
5 * Copyright (C) 2017-2022 Osimis S.A., Belgium
43e613a7756b upgrade to year 2022
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4831
diff changeset
6 * Copyright (C) 2021-2022 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 * This program is distributed in the hope that it will be useful, but
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * General Public License for more details.
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 *
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * You should have received a copy of the GNU General Public License
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 **/
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 #pragma once
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 #include "ServerEnumerations.h"
4045
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
26 #include "../../OrthancFramework/Sources/IDynamicObject.h"
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
27 #include "../../OrthancFramework/Sources/SystemToolbox.h"
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 #include <string>
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
30 #include <json/value.h>
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 namespace Orthanc
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 {
1436
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
34 struct ServerIndexChange : public IDynamicObject
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 {
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 private:
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
37 int64_t seq_;
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 ChangeType changeType_;
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 ResourceType resourceType_;
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 std::string publicId_;
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
41 std::string date_;
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 public:
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 ServerIndexChange(ChangeType changeType,
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 ResourceType resourceType,
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
46 const std::string& publicId) :
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
47 seq_(-1),
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 changeType_(changeType),
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 resourceType_(resourceType),
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
50 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
51 date_(SystemToolbox::GetNowIsoString(true /* use UTC time (not local time) */))
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 {
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 }
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
55 ServerIndexChange(int64_t seq,
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
56 ChangeType changeType,
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
57 ResourceType resourceType,
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 const std::string& date) :
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
60 seq_(seq),
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
61 changeType_(changeType),
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
62 resourceType_(resourceType),
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
63 publicId_(publicId),
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
64 date_(date)
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
65 {
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
1436
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
68 ServerIndexChange(const ServerIndexChange& other)
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
69 : seq_(other.seq_),
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
70 changeType_(other.changeType_),
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
71 resourceType_(other.resourceType_),
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
72 publicId_(other.publicId_),
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
73 date_(other.date_)
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
74 {
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 ServerIndexChange* Clone() const
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
78 {
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
79 return new ServerIndexChange(*this);
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
80 }
0a3e3be59094 uncoupling of SignalChange for Lua scripts
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
81
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
82 int64_t GetSeq() const
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
83 {
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
84 return seq_;
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
85 }
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
86
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 ChangeType GetChangeType() const
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 {
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 return changeType_;
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 }
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 ResourceType GetResourceType() const
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 {
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 return resourceType_;
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 }
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 const std::string& GetPublicId() const
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98 {
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 return publicId_;
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 }
1240
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
101
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
102 const std::string& GetDate() const
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
103 {
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
104 return date_;
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
105 }
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 void Format(Json::Value& item) const
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
108 {
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
109 item = Json::objectValue;
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
110 item["Seq"] = static_cast<int>(seq_);
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
111 item["ChangeType"] = EnumerationToString(changeType_);
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
112 item["ResourceType"] = EnumerationToString(resourceType_);
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
113 item["ID"] = publicId_;
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
114 item["Path"] = GetBasePath(resourceType_, publicId_);
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
115 item["Date"] = date_;
62c35e4b67db refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1198
diff changeset
116 }
1198
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 };
1169528a9a5f refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 }