Mercurial > hg > orthanc
annotate OrthancServer/Sources/ServerJobs/DicomModalityStoreJob.h @ 5343:cba09fd1e234
C89 compliance in sample basic plugin
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Wed, 28 Jun 2023 12:16:54 +0200 |
| parents | 0ea402b4d901 |
| children | 48b8dae6dc77 |
| 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 | |
|
5185
0ea402b4d901
upgrade to year 2023
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4892
diff
changeset
|
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium |
|
0ea402b4d901
upgrade to year 2023
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4892
diff
changeset
|
6 * Copyright (C) 2021-2023 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
| 2602 | 7 * |
| 8 * This program is free software: you can redistribute it and/or | |
| 9 * modify it under the terms of the GNU General Public License as | |
| 10 * published by the Free Software Foundation, either version 3 of the | |
| 11 * License, or (at your option) any later version. | |
| 12 * | |
| 13 * This program is distributed in the hope that it will be useful, but | |
| 14 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 16 * General Public License for more details. | |
| 17 * | |
| 18 * You should have received a copy of the GNU General Public License | |
| 19 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 20 **/ | |
| 21 | |
| 22 | |
| 23 #pragma once | |
| 24 | |
| 4045 | 25 #include "../../../OrthancFramework/Sources/Compatibility.h" |
| 26 #include "../../../OrthancFramework/Sources/JobsEngine/SetOfInstancesJob.h" | |
| 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 | 30 |
| 31 namespace Orthanc | |
| 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 | 35 class DicomModalityStoreJob : public SetOfInstancesJob |
| 36 { | |
| 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 | 46 std::string transactionUid_; |
| 47 std::list<std::string> sopInstanceUids_; | |
| 48 std::list<std::string> sopClassUids_; | |
| 2602 | 49 |
| 2603 | 50 void OpenConnection(); |
| 2602 | 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 | 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 | 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 | 59 public: |
| 4204 | 60 explicit DicomModalityStoreJob(ServerContext& context); |
| 2602 | 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 | 66 { |
|
3875
ea1d32861cfc
moving timeout from DicomAssocation to DicomAssociationParameters
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3870
diff
changeset
|
67 return parameters_; |
| 2602 | 68 } |
| 69 | |
| 2603 | 70 void SetLocalAet(const std::string& aet); |
| 2602 | 71 |
| 2603 | 72 void SetRemoteModality(const RemoteModalityParameters& remote); |
| 2602 | 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 | 76 bool HasMoveOriginator() const |
| 77 { | |
| 78 return moveOriginatorId_ != 0; | |
| 79 } | |
| 80 | |
| 2603 | 81 const std::string& GetMoveOriginatorAet() const; |
| 2602 | 82 |
| 2603 | 83 uint16_t GetMoveOriginatorId() const; |
| 2602 | 84 |
| 85 void SetMoveOriginator(const std::string& aet, | |
| 2603 | 86 int id); |
| 2602 | 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 | 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 | 91 { |
| 92 target = "DicomModalityStore"; | |
| 93 } | |
| 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 | 107 }; |
| 108 } |