Mercurial > hg > orthanc

annotate OrthancServer/Sources/ServerJobs/DicomModalityStoreJob.h @ 5553:28cc06e4859a large-queries

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added ExtendedApiV1: /changes
author Alain Mazy <am@orthanc.team>
date Thu, 11 Apr 2024 19:02:20 +0200
parents 48b8dae6dc77
children f7adfb22e20e
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
5485
48b8dae6dc77 upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5185
diff changeset
5 * Copyright (C) 2017-2024 Osimis S.A., Belgium
48b8dae6dc77 upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5185
diff changeset
6 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 *
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * This program is free software: you can redistribute it and/or
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * modify it under the terms of the GNU General Public License as
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * published by the Free Software Foundation, either version 3 of the
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * License, or (at your option) any later version.
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 *
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * This program is distributed in the hope that it will be useful, but
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * General Public License for more details.
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 *
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * You should have received a copy of the GNU General Public License
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 **/
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 #pragma once
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
4045
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
25 #include "../../../OrthancFramework/Sources/Compatibility.h"
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
26 #include "../../../OrthancFramework/Sources/JobsEngine/SetOfInstancesJob.h"
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
27 #include "../../../OrthancFramework/Sources/DicomNetworking/DicomStoreUserConnection.h"
3862
594263db316a DicomModalityStoreJob now uses DicomStoreUserConnection
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3763
diff changeset
28
594263db316a DicomModalityStoreJob now uses DicomStoreUserConnection
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3763
diff changeset
29 #include <list>
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 namespace Orthanc
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 {
3095
beeeb6096f27 removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
33 class ServerContext;
beeeb6096f27 removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
34
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 class DicomModalityStoreJob : public SetOfInstancesJob
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 {
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 private:
3862
594263db316a DicomModalityStoreJob now uses DicomStoreUserConnection
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3763
diff changeset
38 ServerContext& context_;
3875
ea1d32861cfc moving timeout from DicomAssocation to DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3870
diff changeset
39 DicomAssociationParameters parameters_;
3862
594263db316a DicomModalityStoreJob now uses DicomStoreUserConnection
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3763
diff changeset
40 std::string moveOriginatorAet_;
594263db316a DicomModalityStoreJob now uses DicomStoreUserConnection
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3763
diff changeset
41 uint16_t moveOriginatorId_;
594263db316a DicomModalityStoreJob now uses DicomStoreUserConnection
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3763
diff changeset
42 std::unique_ptr<DicomStoreUserConnection> connection_;
594263db316a DicomModalityStoreJob now uses DicomStoreUserConnection
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3763
diff changeset
43 bool storageCommitment_;
3734
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
44
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
45 // For storage commitment
3735
77183afbf55e simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
46 std::string transactionUid_;
77183afbf55e simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
47 std::list<std::string> sopInstanceUids_;
77183afbf55e simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3734
diff changeset
48 std::list<std::string> sopClassUids_;
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49
2603
988936118354 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2602
diff changeset
50 void OpenConnection();
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51
3734
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
52 void ResetStorageCommitment();
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
53
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 protected:
3763
5ff5d5a0fd28 adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3735
diff changeset
55 virtual bool HandleInstance(const std::string& instance) ORTHANC_OVERRIDE;
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56
3763
5ff5d5a0fd28 adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3735
diff changeset
57 virtual bool HandleTrailingStep() ORTHANC_OVERRIDE;
2842
ff0ed5ea9e4e trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2812
diff changeset
58
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 public:
4204
318c16cfccab cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
60 explicit DicomModalityStoreJob(ServerContext& context);
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61
2664
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2603
diff changeset
62 DicomModalityStoreJob(ServerContext& context,
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2603
diff changeset
63 const Json::Value& serialized);
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2603
diff changeset
64
3875
ea1d32861cfc moving timeout from DicomAssocation to DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3870
diff changeset
65 const DicomAssociationParameters& GetParameters() const
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 {
3875
ea1d32861cfc moving timeout from DicomAssocation to DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3870
diff changeset
67 return parameters_;
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 }
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69
2603
988936118354 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2602
diff changeset
70 void SetLocalAet(const std::string& aet);
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71
2603
988936118354 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2602
diff changeset
72 void SetRemoteModality(const RemoteModalityParameters& remote);
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73
3875
ea1d32861cfc moving timeout from DicomAssocation to DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3870
diff changeset
74 void SetTimeout(uint32_t seconds);
3870
09798f2b985f added a Timeout argument to every DICOM command + 'TargetAet' not mandatory anymore in /retrieve
Alain Mazy <alain@mazy.be>
parents: 3862
diff changeset
75
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 bool HasMoveOriginator() const
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 {
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 return moveOriginatorId_ != 0;
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 }
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80
2603
988936118354 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2602
diff changeset
81 const std::string& GetMoveOriginatorAet() const;
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82
2603
988936118354 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2602
diff changeset
83 uint16_t GetMoveOriginatorId() const;
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 void SetMoveOriginator(const std::string& aet,
2603
988936118354 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2602
diff changeset
86 int id);
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87
3734
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
88 virtual void Stop(JobStopReason reason) ORTHANC_OVERRIDE;
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89
3763
5ff5d5a0fd28 adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3735
diff changeset
90 virtual void GetJobType(std::string& target) ORTHANC_OVERRIDE
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 {
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 target = "DicomModalityStore";
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 }
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94
3763
5ff5d5a0fd28 adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3735
diff changeset
95 virtual void GetPublicContent(Json::Value& value) ORTHANC_OVERRIDE;
2664
a21b244efb37 serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2603
diff changeset
96
3763
5ff5d5a0fd28 adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3735
diff changeset
97 virtual bool Serialize(Json::Value& target) ORTHANC_OVERRIDE;
3734
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
98
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
99 virtual void Reset() ORTHANC_OVERRIDE;
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
100
4fc24b69446a triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3712
diff changeset
101 void EnableStorageCommitment(bool enabled);
3878
661c931f22ad new unit test: OrthancJobsSerialization.DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
102
661c931f22ad new unit test: OrthancJobsSerialization.DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
103 bool HasStorageCommitment() const
661c931f22ad new unit test: OrthancJobsSerialization.DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
104 {
661c931f22ad new unit test: OrthancJobsSerialization.DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
105 return storageCommitment_;
661c931f22ad new unit test: OrthancJobsSerialization.DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3875
diff changeset
106 }
2602
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107 };
c25f1a52acbc reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 }