Mercurial > hg > orthanc
annotate OrthancServer/Plugins/Engine/PluginsJob.h @ 5660:e4d9a872998f
replaced incorrect macro WIN32 by _WIN32
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Sun, 23 Jun 2024 10:24:31 +0200 |
| parents | f7adfb22e20e |
| children |
| 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 | |
|
5640
f7adfb22e20e
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5485
diff
changeset
|
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium |
|
f7adfb22e20e
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5485
diff
changeset
|
6 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium |
|
5485
48b8dae6dc77
upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5310
diff
changeset
|
7 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
| 2810 | 8 * |
| 9 * This program is free software: you can redistribute it and/or | |
| 10 * modify it under the terms of the GNU General Public License as | |
| 11 * published by the Free Software Foundation, either version 3 of the | |
| 12 * License, or (at your option) any later version. | |
| 13 * | |
| 14 * This program is distributed in the hope that it will be useful, but | |
| 15 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 17 * General Public License for more details. | |
| 18 * | |
| 19 * You should have received a copy of the GNU General Public License | |
| 20 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 21 **/ | |
| 22 | |
| 23 | |
| 24 #pragma once | |
| 25 | |
| 26 #if ORTHANC_ENABLE_PLUGINS == 1 | |
| 27 | |
|
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
|
28 #include "../../../OrthancFramework/Sources/Compatibility.h" // For ORTHANC_OVERRIDE |
| 4045 | 29 #include "../../../OrthancFramework/Sources/JobsEngine/IJob.h" |
| 2810 | 30 #include "../Include/orthanc/OrthancCPlugin.h" |
| 31 | |
| 32 namespace Orthanc | |
| 33 { | |
| 34 class PluginsJob : public IJob | |
| 35 { | |
| 36 private: | |
|
5138
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4892
diff
changeset
|
37 _OrthancPluginCreateJob2 parameters_; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4892
diff
changeset
|
38 std::string type_; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4892
diff
changeset
|
39 OrthancPluginJobGetContent deprecatedGetContent_; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4892
diff
changeset
|
40 OrthancPluginJobGetSerialized deprecatedGetSerialized_; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4892
diff
changeset
|
41 |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4892
diff
changeset
|
42 void Setup(); |
| 2810 | 43 |
| 44 public: | |
| 4204 | 45 explicit PluginsJob(const _OrthancPluginCreateJob& parameters); |
| 2810 | 46 |
|
5138
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4892
diff
changeset
|
47 explicit PluginsJob(const _OrthancPluginCreateJob2& parameters); |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4892
diff
changeset
|
48 |
| 2810 | 49 virtual ~PluginsJob(); |
| 50 | |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
51 virtual void Start() ORTHANC_OVERRIDE |
| 2810 | 52 { |
| 53 } | |
| 54 | |
|
3658
2d90dd30858c
providing job ID to the IJob::Step() methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3640
diff
changeset
|
55 virtual JobStepResult Step(const std::string& jobId) ORTHANC_OVERRIDE; |
| 2810 | 56 |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
57 virtual void Reset() ORTHANC_OVERRIDE; |
| 2810 | 58 |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
59 virtual void Stop(JobStopReason reason) ORTHANC_OVERRIDE; |
| 2810 | 60 |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
61 virtual float GetProgress() ORTHANC_OVERRIDE; |
| 2810 | 62 |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
63 virtual void GetJobType(std::string& target) ORTHANC_OVERRIDE |
| 2810 | 64 { |
| 65 target = type_; | |
| 66 } | |
| 67 | |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
68 virtual void GetPublicContent(Json::Value& value) ORTHANC_OVERRIDE; |
| 2810 | 69 |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
70 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
|
71 |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
72 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
|
73 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
|
74 std::string& filename, |
|
3763
5ff5d5a0fd28
adding missing ORTHANC_OVERRIDE
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
75 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
|
76 { |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
77 // TODO |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
78 return false; |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
79 } |
|
5310
b5c502bcaf99
added a route to DELETE /jobs/../archive
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
80 |
|
b5c502bcaf99
added a route to DELETE /jobs/../archive
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
81 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
|
82 { |
|
b5c502bcaf99
added a route to DELETE /jobs/../archive
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
83 // TODO |
|
b5c502bcaf99
added a route to DELETE /jobs/../archive
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
84 return false; |
|
b5c502bcaf99
added a route to DELETE /jobs/../archive
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
85 } |
| 2810 | 86 }; |
| 87 } | |
| 88 | |
| 89 #endif |