Mercurial > hg > orthanc
annotate OrthancServer/Plugins/Engine/PluginsJob.h @ 5571:addccb1590d2
simplifying Orthanc::Logging
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Fri, 26 Apr 2024 14:48:11 +0200 |
| parents | 48b8dae6dc77 |
| children | f7adfb22e20e |
| rev | line source |
|---|---|
| 2810 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
| 4 * Department, University Hospital of Liege, Belgium | |
|
5485
48b8dae6dc77
upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5310
diff
changeset
|
5 * Copyright (C) 2017-2024 Osimis S.A., Belgium |
|
48b8dae6dc77
upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5310
diff
changeset
|
6 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
| 2810 | 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 | |
| 25 #if ORTHANC_ENABLE_PLUGINS == 1 | |
| 26 | |
|
4202
2007ab69ac16
moving ORTHANC_FORCE_INLINE and ORTHANC_OVERRIDE from Enumerations.h to Compatibility.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4045
diff
changeset
|
27 #include "../../../OrthancFramework/Sources/Compatibility.h" // For ORTHANC_OVERRIDE |
| 4045 | 28 #include "../../../OrthancFramework/Sources/JobsEngine/IJob.h" |
| 2810 | 29 #include "../Include/orthanc/OrthancCPlugin.h" |
| 30 | |
| 31 namespace Orthanc | |
| 32 { | |
| 33 class PluginsJob : public IJob | |
| 34 { | |
| 35 private: | |
|
5138
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4892
diff
changeset
|
36 _OrthancPluginCreateJob2 parameters_; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4892
diff
changeset
|
37 std::string type_; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4892
diff
changeset
|
38 OrthancPluginJobGetContent deprecatedGetContent_; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4892
diff
changeset
|
39 OrthancPluginJobGetSerialized deprecatedGetSerialized_; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4892
diff
changeset
|
40 |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4892
diff
changeset
|
41 void Setup(); |
| 2810 | 42 |
| 43 public: | |
| 4204 | 44 explicit PluginsJob(const _OrthancPluginCreateJob& parameters); |
| 2810 | 45 |
|
5138
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4892
diff
changeset
|
46 explicit PluginsJob(const _OrthancPluginCreateJob2& parameters); |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4892
diff
changeset
|
47 |
| 2810 | 48 virtual ~PluginsJob(); |
| 49 | |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
50 virtual void Start() ORTHANC_OVERRIDE |
| 2810 | 51 { |
| 52 } | |
| 53 | |
|
3658
2d90dd30858c
providing job ID to the IJob::Step() methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3640
diff
changeset
|
54 virtual JobStepResult Step(const std::string& jobId) ORTHANC_OVERRIDE; |
| 2810 | 55 |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
56 virtual void Reset() ORTHANC_OVERRIDE; |
| 2810 | 57 |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
58 virtual void Stop(JobStopReason reason) ORTHANC_OVERRIDE; |
| 2810 | 59 |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
60 virtual float GetProgress() ORTHANC_OVERRIDE; |
| 2810 | 61 |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
62 virtual void GetJobType(std::string& target) ORTHANC_OVERRIDE |
| 2810 | 63 { |
| 64 target = type_; | |
| 65 } | |
| 66 | |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
67 virtual void GetPublicContent(Json::Value& value) ORTHANC_OVERRIDE; |
| 2810 | 68 |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
69 virtual bool Serialize(Json::Value& value) ORTHANC_OVERRIDE; |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
70 |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
71 virtual bool GetOutput(std::string& output, |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
72 MimeType& mime, |
|
4805
0a38000b086d
Archive jobs response now contains a header Content-Disposition:filename='archive.zip'
Alain Mazy <am@osimis.io>
parents:
4437
diff
changeset
|
73 std::string& filename, |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
74 const std::string& key) ORTHANC_OVERRIDE |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
75 { |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
76 // TODO |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
77 return false; |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
78 } |
|
5310
b5c502bcaf99
added a route to DELETE /jobs/../archive
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
79 |
|
b5c502bcaf99
added a route to DELETE /jobs/../archive
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
80 virtual bool DeleteOutput(const std::string& key) ORTHANC_OVERRIDE |
|
b5c502bcaf99
added a route to DELETE /jobs/../archive
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
81 { |
|
b5c502bcaf99
added a route to DELETE /jobs/../archive
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
82 // TODO |
|
b5c502bcaf99
added a route to DELETE /jobs/../archive
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
83 return false; |
|
b5c502bcaf99
added a route to DELETE /jobs/../archive
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
84 } |
| 2810 | 85 }; |
| 86 } | |
| 87 | |
| 88 #endif |