annotate Framework/MultiThreading/BagOfTasksProcessor.h @ 289:5f783bf882fe

add warning about anisotropic pixel spacing
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 13 Jul 2023 12:49:50 +0200
parents 20a730889ae2
children 7020852a8fa9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
151
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
254
20a730889ae2 upgrade to 2023
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 242
diff changeset
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium
20a730889ae2 upgrade to 2023
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 242
diff changeset
6 * Copyright (C) 2021-2023 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
151
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 *
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * This program is free software: you can redistribute it and/or
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * modify it under the terms of the GNU Affero General Public License
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * as published by the Free Software Foundation, either version 3 of
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * the License, or (at your option) any later version.
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 *
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * This program is distributed in the hope that it will be useful, but
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * Affero General Public License for more details.
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 *
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * You should have received a copy of the GNU Affero General Public License
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 **/
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 #pragma once
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 #include "BagOfTasks.h"
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
192
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 175
diff changeset
27 #include <MultiThreading/SharedMessageQueue.h>
151
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 #include <stdint.h>
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 #include <map>
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
236
b0ee417b667a migrating new definitions in namespace Orthanc to namespace OrthancWSI
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 216
diff changeset
32 namespace OrthancWSI
151
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 class BagOfTasksProcessor : public boost::noncopyable
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 private:
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 enum BagStatus
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 BagStatus_Running,
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 BagStatus_Canceled,
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 BagStatus_Failed
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 };
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 struct Bag
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 size_t size_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 size_t done_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 BagStatus status_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 Bag() :
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 size_(0),
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 done_(0),
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 status_(BagStatus_Failed)
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 }
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 explicit Bag(size_t size) :
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 size_(size),
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 done_(0),
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 status_(BagStatus_Running)
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 }
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 };
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 class Task;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 typedef std::map<uint64_t, Bag> Bags;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 typedef std::map<uint64_t, bool> ExitStatus;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71
236
b0ee417b667a migrating new definitions in namespace Orthanc to namespace OrthancWSI
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 216
diff changeset
72 Orthanc::SharedMessageQueue queue_;
151
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 boost::mutex mutex_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 uint64_t countBags_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 Bags bags_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 std::vector<boost::thread*> threads_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 ExitStatus exitStatus_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 bool continue_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 boost::condition_variable bagFinished_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 static void Worker(BagOfTasksProcessor* that);
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 void Cancel(int64_t bag);
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 bool Join(int64_t bag);
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 float GetProgress(int64_t bag);
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 void SignalProgress(Task& task,
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 Bag& bag);
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 public:
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 class Handle : public boost::noncopyable
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 friend class BagOfTasksProcessor;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 private:
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 BagOfTasksProcessor& that_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 uint64_t bag_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102 bool hasJoined_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103 bool status_;
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105 Handle(BagOfTasksProcessor& that,
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 uint64_t bag,
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107 bool empty) :
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 that_(that),
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109 bag_(bag),
216
c35a3a0627b9 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 214
diff changeset
110 hasJoined_(empty),
c35a3a0627b9 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 214
diff changeset
111 status_(false)
151
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
112 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113 }
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 public:
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116 ~Handle()
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 Join();
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119 }
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
120
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
121 void Cancel()
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
123 that_.Cancel(bag_);
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
124 }
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
125
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
126 bool Join();
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
127
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
128 float GetProgress()
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
129 {
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
130 return that_.GetProgress(bag_);
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
131 }
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
132 };
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
133
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
134
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
135 explicit BagOfTasksProcessor(size_t countThreads);
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
136
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
137 ~BagOfTasksProcessor();
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
138
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
139 Handle* Submit(BagOfTasks& tasks);
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
140 };
fb8d4cd2f618 fix applications
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
141 }