Mercurial > hg > orthanc

comparison OrthancFramework/Sources/JobsEngine/SetOfInstancesJob.h @ 4044:d25f4c0fa160 framework

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
splitting code into OrthancFramework and OrthancServer
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 10 Jun 2020 20:30:34 +0200
parents Core/JobsEngine/SetOfInstancesJob.h@94f4a18a79cc
children e00f3d089991
comparison
equal deleted inserted replaced
4043:6c6239aec462 4044:d25f4c0fa160
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-2020 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 #include "SetOfCommandsJob.h"
38
39 #include <set>
40
41 namespace Orthanc
42 {
43 class SetOfInstancesJob : public SetOfCommandsJob
44 {
45 private:
46 class InstanceCommand;
47 class TrailingStepCommand;
48 class InstanceUnserializer;
49
50 bool hasTrailingStep_;
51 std::set<std::string> failedInstances_;
52 std::set<std::string> parentResources_;
53
54 protected:
55 virtual bool HandleInstance(const std::string& instance) = 0;
56
57 virtual bool HandleTrailingStep() = 0;
58
59 // Hiding this method, use AddInstance() instead
60 using SetOfCommandsJob::AddCommand;
61
62 public:
63 SetOfInstancesJob();
64
65 SetOfInstancesJob(const Json::Value& source); // Unserialization
66
67 // Only used for reporting in the public content
68 // https://groups.google.com/d/msg/orthanc-users/9GCV88GLEzw/6wAgP_PRAgAJ
69 void AddParentResource(const std::string& resource)
70 {
71 parentResources_.insert(resource);
72 }
73
74 void AddInstance(const std::string& instance);
75
76 void AddTrailingStep();
77
78 size_t GetInstancesCount() const;
79
80 const std::string& GetInstance(size_t index) const;
81
82 bool HasTrailingStep() const
83 {
84 return hasTrailingStep_;
85 }
86
87 const std::set<std::string>& GetFailedInstances() const
88 {
89 return failedInstances_;
90 }
91
92 bool IsFailedInstance(const std::string& instance) const
93 {
94 return failedInstances_.find(instance) != failedInstances_.end();
95 }
96
97 virtual void Start();
98
99 virtual void Reset();
100
101 virtual void GetPublicContent(Json::Value& target);
102
103 virtual bool Serialize(Json::Value& target);
104 };
105 }