annotate OrthancServer/ServerJobs/DicomModalityStoreJob.h @ 3374:d0d6bd633e4c

Reporting of "ParentResources" in "DicomModalityStore" and "DicomModalityStore" jobs
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 14 May 2019 16:38:02 +0200
parents beeeb6096f27
children 94f4a18a79cc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
3060
4e43e67f8ecf preparing for 2019
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2842
diff changeset
5 * Copyright (C) 2017-2019 Osimis S.A., Belgium
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * In addition, as a special exception, the copyright holders of this
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * program give permission to link the code of its release with the
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * the linked executables. You must obey the GNU General Public License
c25f1a52acbc 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
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
c25f1a52acbc 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
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * you do not wish to do so, delete this exception statement from your
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * version. If you delete this exception statement from all source files
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * in the program, then also delete it here.
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 *
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #pragma once
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 #include "../../Core/JobsEngine/SetOfInstancesJob.h"
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 #include "../../Core/DicomNetworking/DicomUserConnection.h"
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 namespace Orthanc
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 {
3095
beeeb6096f27 removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
41 class ServerContext;
beeeb6096f27 removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
42
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 class DicomModalityStoreJob : public SetOfInstancesJob
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 {
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 private:
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 ServerContext& context_;
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 std::string localAet_;
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 RemoteModalityParameters remote_;
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 std::string moveOriginatorAet_;
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 uint16_t moveOriginatorId_;
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 std::auto_ptr<DicomUserConnection> connection_;
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52
2603
988936118354 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2602
diff changeset
53 void OpenConnection();
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 protected:
2603
988936118354 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2602
diff changeset
56 virtual bool HandleInstance(const std::string& instance);
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57
2842
ff0ed5ea9e4e trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2812
diff changeset
58 virtual bool HandleTrailingStep();
ff0ed5ea9e4e trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2812
diff changeset
59
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 public:
2603
988936118354 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2602
diff changeset
61 DicomModalityStoreJob(ServerContext& context);
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62
2664
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2603
diff changeset
63 DicomModalityStoreJob(ServerContext& context,
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2603
diff changeset
64 const Json::Value& serialized);
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2603
diff changeset
65
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 const std::string& GetLocalAet() const
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 {
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 return localAet_;
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 }
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70
2603
988936118354 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2602
diff changeset
71 void SetLocalAet(const std::string& aet);
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 const RemoteModalityParameters& GetRemoteModality() const
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 {
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 return remote_;
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 }
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77
2603
988936118354 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2602
diff changeset
78 void SetRemoteModality(const RemoteModalityParameters& remote);
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 bool HasMoveOriginator() const
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 {
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 return moveOriginatorId_ != 0;
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 }
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84
2603
988936118354 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2602
diff changeset
85 const std::string& GetMoveOriginatorAet() const;
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86
2603
988936118354 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2602
diff changeset
87 uint16_t GetMoveOriginatorId() const;
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 void SetMoveOriginator(const std::string& aet,
2603
988936118354 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2602
diff changeset
90 int id);
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91
2812
ea7aea6f6a95 improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2811
diff changeset
92 virtual void Stop(JobStopReason reason);
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 virtual void GetJobType(std::string& target)
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 {
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 target = "DicomModalityStore";
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 }
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98
2603
988936118354 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2602
diff changeset
99 virtual void GetPublicContent(Json::Value& value);
2664
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2603
diff changeset
100
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2603
diff changeset
101 virtual bool Serialize(Json::Value& target);
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102 };
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103 }