annotate OrthancServer/ServerJobs/ResourceModificationJob.h @ 2842:ff0ed5ea9e4e

trailing step in SetOfInstancesJob
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 26 Sep 2018 15:55:42 +0200
parents ea7aea6f6a95
children 8b00e4cb4a6b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2642
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 * Copyright (C) 2017-2018 Osimis S.A., Belgium
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * In addition, as a special exception, the copyright holders of this
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * program give permission to link the code of its release with the
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * the linked executables. You must obey the GNU General Public License
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * in all respects for all of the code used other than "OpenSSL". If you
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
ccc470091ea6 reorganization
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
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * you do not wish to do so, delete this exception statement from your
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * version. If you delete this exception statement from all source files
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * in the program, then also delete it here.
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 *
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #pragma once
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 #include "../../Core/JobsEngine/SetOfInstancesJob.h"
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 #include "../ServerContext.h"
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 namespace Orthanc
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 {
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 class ResourceModificationJob : public SetOfInstancesJob
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 {
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 public:
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 class Output : public boost::noncopyable
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 {
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 private:
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 boost::mutex mutex_;
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 ResourceType level_;
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 bool isFirst_;
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 std::string id_;
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 std::string patientId_;
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 public:
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 Output(ResourceType level);
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 ResourceType GetLevel() const
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 {
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 return level_;
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 }
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 void Update(DicomInstanceHasher& hasher);
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 bool Format(Json::Value& target);
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 bool GetIdentifier(std::string& id);
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 };
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 private:
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 ServerContext& context_;
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 std::auto_ptr<DicomModification> modification_;
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 boost::shared_ptr<Output> output_;
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 bool isAnonymization_;
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 DicomInstanceOrigin origin_;
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 protected:
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 virtual bool HandleInstance(const std::string& instance);
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77
2842
ff0ed5ea9e4e trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2812
diff changeset
78 virtual bool HandleTrailingStep();
ff0ed5ea9e4e trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2812
diff changeset
79
2642
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 public:
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 ResourceModificationJob(ServerContext& context) :
2842
ff0ed5ea9e4e trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2812
diff changeset
82 SetOfInstancesJob(false /* no trailing step */),
2642
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 context_(context),
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 isAnonymization_(false)
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 {
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 }
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87
2664
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
88 ResourceModificationJob(ServerContext& context,
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
89 const Json::Value& serialized);
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
90
2642
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 void SetModification(DicomModification* modification, // Takes ownership
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 bool isAnonymization);
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 void SetOutput(boost::shared_ptr<Output>& output);
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 void SetOrigin(const DicomInstanceOrigin& origin);
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98 void SetOrigin(const RestApiCall& call);
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99
2664
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
100 const DicomModification& GetModification() const;
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
101
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
102 bool IsAnonymization() const
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
103 {
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
104 return isAnonymization_;
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
105 }
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
106
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
107 const DicomInstanceOrigin& GetOrigin() const
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
108 {
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
109 return origin_;
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
110 }
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2663
diff changeset
111
2812
ea7aea6f6a95 improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2811
diff changeset
112 virtual void Stop(JobStopReason reason)
2642
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113 {
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 }
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116 virtual void GetJobType(std::string& target)
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 {
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 target = "ResourceModification";
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119 }
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
120
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
121 virtual void GetPublicContent(Json::Value& value);
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122
2663
228e2783ce83 some jobs might not be serializable
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2648
diff changeset
123 virtual bool Serialize(Json::Value& value);
2642
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
124 };
ccc470091ea6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
125 }