Mercurial > hg > orthanc
annotate Core/JobsEngine/SetOfInstancesJob.h @ 2858:39b171502059
added SingleValueObject: a simple implementation of a IDynamicObject that stores a single typed value
| author | am@osimis.io |
|---|---|
| date | Fri, 05 Oct 2018 10:39:42 +0200 |
| parents | ff0ed5ea9e4e |
| children | 8b00e4cb4a6b |
| rev | line source |
|---|---|
| 2585 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
| 4 * Department, University Hospital of Liege, Belgium | |
| 5 * Copyright (C) 2017-2018 Osimis S.A., Belgium | |
| 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 SetOfInstancesJob : public IJob | |
| 43 { | |
| 44 private: | |
|
2842
ff0ed5ea9e4e
trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
45 bool hasTrailingStep_; |
| 2585 | 46 bool started_; |
| 47 std::vector<std::string> instances_; | |
| 48 bool permissive_; | |
| 49 size_t position_; | |
| 50 std::set<std::string> failedInstances_; | |
|
2624
714dcddeb65f
asynchronous c-movoe
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2598
diff
changeset
|
51 std::string description_; |
| 2585 | 52 |
| 53 protected: | |
| 54 virtual bool HandleInstance(const std::string& instance) = 0; | |
| 55 | |
|
2842
ff0ed5ea9e4e
trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
56 virtual bool HandleTrailingStep() = 0; |
|
ff0ed5ea9e4e
trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
57 |
| 2585 | 58 public: |
|
2842
ff0ed5ea9e4e
trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
59 SetOfInstancesJob(bool hasTrailingStep); |
| 2585 | 60 |
| 2652 | 61 SetOfInstancesJob(const Json::Value& s); // Unserialization |
| 62 | |
|
2842
ff0ed5ea9e4e
trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
63 bool HasTrailingStep() const |
|
ff0ed5ea9e4e
trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
64 { |
|
ff0ed5ea9e4e
trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
65 return hasTrailingStep_; |
|
ff0ed5ea9e4e
trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
66 } |
|
ff0ed5ea9e4e
trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
67 |
|
2657
5eea2f11e8df
JobsSerialization.GenericJobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2652
diff
changeset
|
68 size_t GetPosition() const |
|
5eea2f11e8df
JobsSerialization.GenericJobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2652
diff
changeset
|
69 { |
|
5eea2f11e8df
JobsSerialization.GenericJobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2652
diff
changeset
|
70 return position_; |
|
5eea2f11e8df
JobsSerialization.GenericJobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2652
diff
changeset
|
71 } |
|
5eea2f11e8df
JobsSerialization.GenericJobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2652
diff
changeset
|
72 |
|
2624
714dcddeb65f
asynchronous c-movoe
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2598
diff
changeset
|
73 void SetDescription(const std::string& description) |
|
714dcddeb65f
asynchronous c-movoe
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2598
diff
changeset
|
74 { |
|
714dcddeb65f
asynchronous c-movoe
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2598
diff
changeset
|
75 description_ = description; |
|
714dcddeb65f
asynchronous c-movoe
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2598
diff
changeset
|
76 } |
|
714dcddeb65f
asynchronous c-movoe
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2598
diff
changeset
|
77 |
|
714dcddeb65f
asynchronous c-movoe
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2598
diff
changeset
|
78 const std::string& GetDescription() const |
|
714dcddeb65f
asynchronous c-movoe
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2598
diff
changeset
|
79 { |
|
714dcddeb65f
asynchronous c-movoe
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2598
diff
changeset
|
80 return description_; |
|
714dcddeb65f
asynchronous c-movoe
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2598
diff
changeset
|
81 } |
|
714dcddeb65f
asynchronous c-movoe
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2598
diff
changeset
|
82 |
| 2585 | 83 void Reserve(size_t size); |
| 84 | |
| 85 size_t GetInstancesCount() const | |
| 86 { | |
| 87 return instances_.size(); | |
| 88 } | |
| 89 | |
|
2842
ff0ed5ea9e4e
trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
90 size_t GetStepsCount() const; |
|
ff0ed5ea9e4e
trailing step in SetOfInstancesJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
91 |
| 2585 | 92 void AddInstance(const std::string& instance); |
| 93 | |
| 94 bool IsPermissive() const | |
| 95 { | |
| 96 return permissive_; | |
| 97 } | |
| 98 | |
| 99 void SetPermissive(bool permissive); | |
| 100 | |
|
2812
ea7aea6f6a95
improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2663
diff
changeset
|
101 virtual void Reset(); |
| 2585 | 102 |
| 103 virtual void Start() | |
| 104 { | |
| 105 started_ = true; | |
| 106 } | |
| 107 | |
| 108 virtual float GetProgress(); | |
| 109 | |
| 110 bool IsStarted() const | |
| 111 { | |
| 112 return started_; | |
| 113 } | |
| 114 | |
|
2657
5eea2f11e8df
JobsSerialization.GenericJobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2652
diff
changeset
|
115 const std::string& GetInstance(size_t index) const; |
|
5eea2f11e8df
JobsSerialization.GenericJobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2652
diff
changeset
|
116 |
| 2585 | 117 const std::set<std::string>& GetFailedInstances() const |
| 118 { | |
| 119 return failedInstances_; | |
| 120 } | |
|
2657
5eea2f11e8df
JobsSerialization.GenericJobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2652
diff
changeset
|
121 |
|
5eea2f11e8df
JobsSerialization.GenericJobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2652
diff
changeset
|
122 bool IsFailedInstance(const std::string& instance) const |
|
5eea2f11e8df
JobsSerialization.GenericJobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2652
diff
changeset
|
123 { |
|
5eea2f11e8df
JobsSerialization.GenericJobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2652
diff
changeset
|
124 return failedInstances_.find(instance) != failedInstances_.end(); |
|
5eea2f11e8df
JobsSerialization.GenericJobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2652
diff
changeset
|
125 } |
|
5eea2f11e8df
JobsSerialization.GenericJobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2652
diff
changeset
|
126 |
|
2812
ea7aea6f6a95
improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2663
diff
changeset
|
127 virtual JobStepResult Step(); |
| 2585 | 128 |
|
2640
c691fcf66071
ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2624
diff
changeset
|
129 virtual void GetPublicContent(Json::Value& value); |
|
c691fcf66071
ResourceModificationJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2624
diff
changeset
|
130 |
|
2663
228e2783ce83
some jobs might not be serializable
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2657
diff
changeset
|
131 virtual bool Serialize(Json::Value& value); |
| 2585 | 132 }; |
| 133 } |