Mercurial > hg > orthanc
annotate OrthancFramework/Sources/JobsEngine/SetOfCommandsJob.h @ 5088:8d2c39e8880b
more doc
| author | Alain Mazy <am@osimis.io> |
|---|---|
| date | Mon, 26 Sep 2022 19:08:03 +0200 |
| parents | 43e613a7756b |
| children | 0ea402b4d901 |
| rev | line source |
|---|---|
| 2860 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
| 4 * Department, University Hospital of Liege, Belgium | |
|
4870
43e613a7756b
upgrade to year 2022
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4831
diff
changeset
|
5 * Copyright (C) 2017-2022 Osimis S.A., Belgium |
|
43e613a7756b
upgrade to year 2022
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4831
diff
changeset
|
6 * Copyright (C) 2021-2022 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
| 2860 | 7 * |
| 8 * This program is free software: you can redistribute it and/or | |
|
4119
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
9 * modify it under the terms of the GNU Lesser General Public License |
|
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
10 * as published by the Free Software Foundation, either version 3 of |
|
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
11 * the License, or (at your option) any later version. |
| 2860 | 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 | |
|
4119
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
16 * Lesser General Public License for more details. |
| 2860 | 17 * |
|
4119
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
18 * You should have received a copy of the GNU Lesser General Public |
|
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
19 * License along with this program. If not, see |
|
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
20 * <http://www.gnu.org/licenses/>. |
| 2860 | 21 **/ |
| 22 | |
| 23 | |
| 24 #pragma once | |
| 25 | |
| 26 #include "IJob.h" | |
| 27 | |
|
4202
2007ab69ac16
moving ORTHANC_FORCE_INLINE and ORTHANC_OVERRIDE from Enumerations.h to Compatibility.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4119
diff
changeset
|
28 #include "../Compatibility.h" // For ORTHANC_OVERRIDE |
|
2007ab69ac16
moving ORTHANC_FORCE_INLINE and ORTHANC_OVERRIDE from Enumerations.h to Compatibility.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4119
diff
changeset
|
29 |
| 2860 | 30 #include <set> |
| 31 | |
| 32 namespace Orthanc | |
| 33 { | |
|
4063
e00f3d089991
shared library of orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
34 class ORTHANC_PUBLIC SetOfCommandsJob : public IJob |
| 2860 | 35 { |
| 36 public: | |
| 37 class ICommand : public boost::noncopyable | |
| 38 { | |
| 39 public: | |
|
4303
44b53a2c0a13
improving detection of ABI compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4300
diff
changeset
|
40 virtual ~ICommand() |
|
44b53a2c0a13
improving detection of ABI compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4300
diff
changeset
|
41 { |
|
44b53a2c0a13
improving detection of ABI compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4300
diff
changeset
|
42 } |
| 2860 | 43 |
|
3658
2d90dd30858c
providing job ID to the IJob::Step() methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3640
diff
changeset
|
44 virtual bool Execute(const std::string& jobId) = 0; |
| 2860 | 45 |
| 46 virtual void Serialize(Json::Value& target) const = 0; | |
| 47 }; | |
| 48 | |
| 49 class ICommandUnserializer : public boost::noncopyable | |
| 50 { | |
| 51 public: | |
|
4303
44b53a2c0a13
improving detection of ABI compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4300
diff
changeset
|
52 virtual ~ICommandUnserializer() |
|
44b53a2c0a13
improving detection of ABI compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4300
diff
changeset
|
53 { |
|
44b53a2c0a13
improving detection of ABI compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4300
diff
changeset
|
54 } |
| 2860 | 55 |
| 56 virtual ICommand* Unserialize(const Json::Value& source) const = 0; | |
| 57 }; | |
| 58 | |
| 59 private: | |
| 60 bool started_; | |
| 61 std::vector<ICommand*> commands_; | |
| 62 bool permissive_; | |
| 63 size_t position_; | |
| 64 std::string description_; | |
| 65 | |
| 66 public: | |
| 67 SetOfCommandsJob(); | |
| 68 | |
| 69 SetOfCommandsJob(ICommandUnserializer* unserializer /* takes ownership */, | |
| 70 const Json::Value& source); | |
| 71 | |
| 72 virtual ~SetOfCommandsJob(); | |
| 73 | |
| 4300 | 74 size_t GetPosition() const; |
| 2860 | 75 |
| 4300 | 76 void SetDescription(const std::string& description); |
| 2860 | 77 |
| 4304 | 78 const std::string& GetDescription() const; |
| 2860 | 79 |
| 80 void Reserve(size_t size); | |
| 81 | |
| 4300 | 82 size_t GetCommandsCount() const; |
| 2860 | 83 |
| 84 void AddCommand(ICommand* command); // Takes ownership | |
| 85 | |
| 4300 | 86 bool IsPermissive() const; |
| 2860 | 87 |
| 88 void SetPermissive(bool permissive); | |
| 89 | |
|
3674
9201a7858cce
fix warnings with recent wasm
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
90 virtual void Reset() ORTHANC_OVERRIDE; |
| 2860 | 91 |
| 4300 | 92 virtual void Start() ORTHANC_OVERRIDE; |
| 2860 | 93 |
|
3674
9201a7858cce
fix warnings with recent wasm
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
94 virtual float GetProgress() ORTHANC_OVERRIDE; |
| 2860 | 95 |
| 4300 | 96 bool IsStarted() const; |
| 2860 | 97 |
| 98 const ICommand& GetCommand(size_t index) const; | |
| 99 | |
|
3658
2d90dd30858c
providing job ID to the IJob::Step() methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3640
diff
changeset
|
100 virtual JobStepResult Step(const std::string& jobId) ORTHANC_OVERRIDE; |
| 2860 | 101 |
|
3674
9201a7858cce
fix warnings with recent wasm
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
102 virtual void GetPublicContent(Json::Value& value) ORTHANC_OVERRIDE; |
| 2860 | 103 |
|
3674
9201a7858cce
fix warnings with recent wasm
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3658
diff
changeset
|
104 virtual bool Serialize(Json::Value& target) ORTHANC_OVERRIDE; |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2860
diff
changeset
|
105 |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2860
diff
changeset
|
106 virtual bool GetOutput(std::string& output, |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2860
diff
changeset
|
107 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
|
108 std::string& filename, |
| 4300 | 109 const std::string& key) ORTHANC_OVERRIDE; |
| 2860 | 110 }; |
| 111 } |