Mercurial > hg > orthanc
annotate Core/JobsEngine/SetOfCommandsJob.h @ 3670:e64432336055 storage-commitment
integration mainline->storage-commitment
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Fri, 14 Feb 2020 09:05:06 +0100 |
| parents | 2d90dd30858c |
| children | 9201a7858cce |
| 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 | |
|
3640
94f4a18a79cc
upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium |
| 2860 | 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 | |
| 36 #include "IJob.h" | |
| 37 | |
| 38 #include <set> | |
| 39 | |
| 40 namespace Orthanc | |
| 41 { | |
| 42 class SetOfCommandsJob : public IJob | |
| 43 { | |
| 44 public: | |
| 45 class ICommand : public boost::noncopyable | |
| 46 { | |
| 47 public: | |
| 48 virtual ~ICommand() | |
| 49 { | |
| 50 } | |
| 51 | |
|
3658
2d90dd30858c
providing job ID to the IJob::Step() methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3640
diff
changeset
|
52 virtual bool Execute(const std::string& jobId) = 0; |
| 2860 | 53 |
| 54 virtual void Serialize(Json::Value& target) const = 0; | |
| 55 }; | |
| 56 | |
| 57 class ICommandUnserializer : public boost::noncopyable | |
| 58 { | |
| 59 public: | |
| 60 virtual ~ICommandUnserializer() | |
| 61 { | |
| 62 } | |
| 63 | |
| 64 virtual ICommand* Unserialize(const Json::Value& source) const = 0; | |
| 65 }; | |
| 66 | |
| 67 private: | |
| 68 bool started_; | |
| 69 std::vector<ICommand*> commands_; | |
| 70 bool permissive_; | |
| 71 size_t position_; | |
| 72 std::string description_; | |
| 73 | |
| 74 public: | |
| 75 SetOfCommandsJob(); | |
| 76 | |
| 77 SetOfCommandsJob(ICommandUnserializer* unserializer /* takes ownership */, | |
| 78 const Json::Value& source); | |
| 79 | |
| 80 virtual ~SetOfCommandsJob(); | |
| 81 | |
| 82 size_t GetPosition() const | |
| 83 { | |
| 84 return position_; | |
| 85 } | |
| 86 | |
| 87 void SetDescription(const std::string& description) | |
| 88 { | |
| 89 description_ = description; | |
| 90 } | |
| 91 | |
| 92 const std::string& GetDescription() const | |
| 93 { | |
| 94 return description_; | |
| 95 } | |
| 96 | |
| 97 void Reserve(size_t size); | |
| 98 | |
| 99 size_t GetCommandsCount() const | |
| 100 { | |
| 101 return commands_.size(); | |
| 102 } | |
| 103 | |
| 104 void AddCommand(ICommand* command); // Takes ownership | |
| 105 | |
| 106 bool IsPermissive() const | |
| 107 { | |
| 108 return permissive_; | |
| 109 } | |
| 110 | |
| 111 void SetPermissive(bool permissive); | |
| 112 | |
| 113 virtual void Reset(); | |
| 114 | |
| 115 virtual void Start() | |
| 116 { | |
| 117 started_ = true; | |
| 118 } | |
| 119 | |
| 120 virtual float GetProgress(); | |
| 121 | |
| 122 bool IsStarted() const | |
| 123 { | |
| 124 return started_; | |
| 125 } | |
| 126 | |
| 127 const ICommand& GetCommand(size_t index) const; | |
| 128 | |
|
3658
2d90dd30858c
providing job ID to the IJob::Step() methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3640
diff
changeset
|
129 virtual JobStepResult Step(const std::string& jobId) ORTHANC_OVERRIDE; |
| 2860 | 130 |
| 131 virtual void GetPublicContent(Json::Value& value); | |
| 132 | |
| 133 virtual bool Serialize(Json::Value& target); | |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2860
diff
changeset
|
134 |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2860
diff
changeset
|
135 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
|
136 MimeType& mime, |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2860
diff
changeset
|
137 const std::string& key) |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2860
diff
changeset
|
138 { |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2860
diff
changeset
|
139 return false; |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2860
diff
changeset
|
140 } |
| 2860 | 141 }; |
| 142 } |