Mercurial > hg > orthanc
annotate OrthancServer/Sources/ServerJobs/DicomModalityStoreJob.h @ 4399:80fd140b12ba
New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Wed, 23 Dec 2020 12:21:03 +0100 |
| parents | 318c16cfccab |
| children | d9473bd5ed43 |
| rev | line source |
|---|---|
| 2602 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
| 4 * Department, University Hospital of Liege, Belgium | |
|
3640
94f4a18a79cc
upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3095
diff
changeset
|
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium |
| 2602 | 6 * |
| 7 * This program is free software: you can redistribute it and/or | |
| 8 * modify it under the terms of the GNU General Public License as | |
| 9 * published by the Free Software Foundation, either version 3 of the | |
| 10 * License, or (at your option) any later version. | |
| 11 * | |
| 12 * In addition, as a special exception, the copyright holders of this | |
| 13 * program give permission to link the code of its release with the | |
| 14 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
| 15 * that use the same license as the "OpenSSL" library), and distribute | |
| 16 * the linked executables. You must obey the GNU General Public License | |
| 17 * in all respects for all of the code used other than "OpenSSL". If you | |
| 18 * modify file(s) with this exception, you may extend this exception to | |
| 19 * your version of the file(s), but you are not obligated to do so. If | |
| 20 * you do not wish to do so, delete this exception statement from your | |
| 21 * version. If you delete this exception statement from all source files | |
| 22 * in the program, then also delete it here. | |
| 23 * | |
| 24 * This program is distributed in the hope that it will be useful, but | |
| 25 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 27 * General Public License for more details. | |
| 28 * | |
| 29 * You should have received a copy of the GNU General Public License | |
| 30 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 31 **/ | |
| 32 | |
| 33 | |
| 34 #pragma once | |
| 35 | |
| 4045 | 36 #include "../../../OrthancFramework/Sources/Compatibility.h" |
| 37 #include "../../../OrthancFramework/Sources/JobsEngine/SetOfInstancesJob.h" | |
| 38 #include "../../../OrthancFramework/Sources/DicomNetworking/DicomStoreUserConnection.h" | |
|
3862
594263db316a
DicomModalityStoreJob now uses DicomStoreUserConnection
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
39 |
|
594263db316a
DicomModalityStoreJob now uses DicomStoreUserConnection
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
40 #include <list> |
| 2602 | 41 |
| 42 namespace Orthanc | |
| 43 { | |
|
3095
beeeb6096f27
removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
44 class ServerContext; |
|
beeeb6096f27
removing dependencies upon ServerContext
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
45 |
| 2602 | 46 class DicomModalityStoreJob : public SetOfInstancesJob |
| 47 { | |
| 48 private: | |
|
3862
594263db316a
DicomModalityStoreJob now uses DicomStoreUserConnection
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
49 ServerContext& context_; |
|
3875
ea1d32861cfc
moving timeout from DicomAssocation to DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3870
diff
changeset
|
50 DicomAssociationParameters parameters_; |
|
3862
594263db316a
DicomModalityStoreJob now uses DicomStoreUserConnection
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
51 std::string moveOriginatorAet_; |
|
594263db316a
DicomModalityStoreJob now uses DicomStoreUserConnection
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
52 uint16_t moveOriginatorId_; |
|
594263db316a
DicomModalityStoreJob now uses DicomStoreUserConnection
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
53 std::unique_ptr<DicomStoreUserConnection> connection_; |
|
594263db316a
DicomModalityStoreJob now uses DicomStoreUserConnection
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3763
diff
changeset
|
54 bool storageCommitment_; |
|
3734
4fc24b69446a
triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3712
diff
changeset
|
55 |
|
4fc24b69446a
triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3712
diff
changeset
|
56 // For storage commitment |
| 3735 | 57 std::string transactionUid_; |
| 58 std::list<std::string> sopInstanceUids_; | |
| 59 std::list<std::string> sopClassUids_; | |
| 2602 | 60 |
| 2603 | 61 void OpenConnection(); |
| 2602 | 62 |
|
3734
4fc24b69446a
triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3712
diff
changeset
|
63 void ResetStorageCommitment(); |
|
4fc24b69446a
triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3712
diff
changeset
|
64 |
| 2602 | 65 protected: |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3735
diff
changeset
|
66 virtual bool HandleInstance(const std::string& instance) ORTHANC_OVERRIDE; |
| 2602 | 67 |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3735
diff
changeset
|
68 virtual bool HandleTrailingStep() ORTHANC_OVERRIDE; |
|
2842
ff0ed5ea9e4e
trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
69 |
| 2602 | 70 public: |
| 4204 | 71 explicit DicomModalityStoreJob(ServerContext& context); |
| 2602 | 72 |
|
2664
a21b244efb37
serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2603
diff
changeset
|
73 DicomModalityStoreJob(ServerContext& context, |
|
a21b244efb37
serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2603
diff
changeset
|
74 const Json::Value& serialized); |
|
a21b244efb37
serialization of DicomModalityStoreJob, OrthancPeerStoreJob and ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2603
diff
changeset
|
75 |
|
3875
ea1d32861cfc
moving timeout from DicomAssocation to DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3870
diff
changeset
|
76 const DicomAssociationParameters& GetParameters() const |
| 2602 | 77 { |
|
3875
ea1d32861cfc
moving timeout from DicomAssocation to DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3870
diff
changeset
|
78 return parameters_; |
| 2602 | 79 } |
| 80 | |
| 2603 | 81 void SetLocalAet(const std::string& aet); |
| 2602 | 82 |
| 2603 | 83 void SetRemoteModality(const RemoteModalityParameters& remote); |
| 2602 | 84 |
|
3875
ea1d32861cfc
moving timeout from DicomAssocation to DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3870
diff
changeset
|
85 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
|
86 |
| 2602 | 87 bool HasMoveOriginator() const |
| 88 { | |
| 89 return moveOriginatorId_ != 0; | |
| 90 } | |
| 91 | |
| 2603 | 92 const std::string& GetMoveOriginatorAet() const; |
| 2602 | 93 |
| 2603 | 94 uint16_t GetMoveOriginatorId() const; |
| 2602 | 95 |
| 96 void SetMoveOriginator(const std::string& aet, | |
| 2603 | 97 int id); |
| 2602 | 98 |
|
3734
4fc24b69446a
triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3712
diff
changeset
|
99 virtual void Stop(JobStopReason reason) ORTHANC_OVERRIDE; |
| 2602 | 100 |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3735
diff
changeset
|
101 virtual void GetJobType(std::string& target) ORTHANC_OVERRIDE |
| 2602 | 102 { |
| 103 target = "DicomModalityStore"; | |
| 104 } | |
| 105 | |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3735
diff
changeset
|
106 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
|
107 |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3735
diff
changeset
|
108 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
|
109 |
|
4fc24b69446a
triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3712
diff
changeset
|
110 virtual void Reset() ORTHANC_OVERRIDE; |
|
4fc24b69446a
triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3712
diff
changeset
|
111 |
|
4fc24b69446a
triggering storage commitment scu from REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3712
diff
changeset
|
112 void EnableStorageCommitment(bool enabled); |
|
3878
661c931f22ad
new unit test: OrthancJobsSerialization.DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3875
diff
changeset
|
113 |
|
661c931f22ad
new unit test: OrthancJobsSerialization.DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3875
diff
changeset
|
114 bool HasStorageCommitment() const |
|
661c931f22ad
new unit test: OrthancJobsSerialization.DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3875
diff
changeset
|
115 { |
|
661c931f22ad
new unit test: OrthancJobsSerialization.DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3875
diff
changeset
|
116 return storageCommitment_; |
|
661c931f22ad
new unit test: OrthancJobsSerialization.DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3875
diff
changeset
|
117 } |
| 2602 | 118 }; |
| 119 } |