Mercurial > hg > orthanc
annotate OrthancFramework/Sources/JobsEngine/JobInfo.cpp @ 4733:1db3b79d97bd
Error code and description of jobs are now saved into the Orthanc database
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Mon, 28 Jun 2021 14:25:37 +0200 |
| parents | 08ee98bf103e |
| children | e1711b6e141f |
| rev | line source |
|---|---|
| 2569 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
| 4 * Department, University Hospital of Liege, Belgium | |
|
4437
d9473bd5ed43
upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4300
diff
changeset
|
5 * Copyright (C) 2017-2021 Osimis S.A., Belgium |
| 2569 | 6 * |
| 7 * 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:
4044
diff
changeset
|
8 * 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:
4044
diff
changeset
|
9 * 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:
4044
diff
changeset
|
10 * the License, or (at your option) any later version. |
| 2569 | 11 * |
| 12 * This program is distributed in the hope that it will be useful, but | |
| 13 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 * 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:
4044
diff
changeset
|
15 * Lesser General Public License for more details. |
| 2569 | 16 * |
|
4119
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
17 * 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:
4044
diff
changeset
|
18 * 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:
4044
diff
changeset
|
19 * <http://www.gnu.org/licenses/>. |
| 2569 | 20 **/ |
| 21 | |
| 22 | |
| 23 #include "../PrecompiledHeaders.h" | |
|
3585
113a9643e8bb
Suppressed a few warnings when building with emscripten (clang) + numeric truncation warnings
Benjamin Golinvaux <bgo@osimis.io>
parents:
3060
diff
changeset
|
24 |
|
113a9643e8bb
Suppressed a few warnings when building with emscripten (clang) + numeric truncation warnings
Benjamin Golinvaux <bgo@osimis.io>
parents:
3060
diff
changeset
|
25 #ifdef __EMSCRIPTEN__ |
|
113a9643e8bb
Suppressed a few warnings when building with emscripten (clang) + numeric truncation warnings
Benjamin Golinvaux <bgo@osimis.io>
parents:
3060
diff
changeset
|
26 /* |
|
113a9643e8bb
Suppressed a few warnings when building with emscripten (clang) + numeric truncation warnings
Benjamin Golinvaux <bgo@osimis.io>
parents:
3060
diff
changeset
|
27 Avoid this error: |
|
113a9643e8bb
Suppressed a few warnings when building with emscripten (clang) + numeric truncation warnings
Benjamin Golinvaux <bgo@osimis.io>
parents:
3060
diff
changeset
|
28 |
|
113a9643e8bb
Suppressed a few warnings when building with emscripten (clang) + numeric truncation warnings
Benjamin Golinvaux <bgo@osimis.io>
parents:
3060
diff
changeset
|
29 .../boost/math/special_functions/round.hpp:118:12: warning: implicit conversion from 'std::__2::numeric_limits<long long>::type' (aka 'long long') to 'float' changes value from 9223372036854775807 to 9223372036854775808 [-Wimplicit-int-float-conversion] |
|
113a9643e8bb
Suppressed a few warnings when building with emscripten (clang) + numeric truncation warnings
Benjamin Golinvaux <bgo@osimis.io>
parents:
3060
diff
changeset
|
30 .../boost/math/special_functions/round.hpp:125:11: note: in instantiation of function template specialization 'boost::math::llround<float, boost::math::policies::policy<boost::math::policies::default_policy, boost::math::policies::default_policy, boost::math::policies::default_policy, boost::math::policies::default_policy, boost::math::policies::default_policy, boost::math::policies::default_policy, boost::math::policies::default_policy, boost::math::policies::default_policy, boost::math::policies::default_policy, boost::math::policies::default_policy, boost::math::policies::default_policy> >' requested here |
|
113a9643e8bb
Suppressed a few warnings when building with emscripten (clang) + numeric truncation warnings
Benjamin Golinvaux <bgo@osimis.io>
parents:
3060
diff
changeset
|
31 .../orthanc/Core/JobsEngine/JobInfo.cpp:69:44: note: in instantiation of function template specialization 'boost::math::llround<float>' requested here |
|
113a9643e8bb
Suppressed a few warnings when building with emscripten (clang) + numeric truncation warnings
Benjamin Golinvaux <bgo@osimis.io>
parents:
3060
diff
changeset
|
32 |
|
113a9643e8bb
Suppressed a few warnings when building with emscripten (clang) + numeric truncation warnings
Benjamin Golinvaux <bgo@osimis.io>
parents:
3060
diff
changeset
|
33 .../boost/math/special_functions/round.hpp:86:12: warning: implicit conversion from 'std::__2::numeric_limits<int>::type' (aka 'int') to 'float' changes value from 2147483647 to 2147483648 [-Wimplicit-int-float-conversion] |
|
113a9643e8bb
Suppressed a few warnings when building with emscripten (clang) + numeric truncation warnings
Benjamin Golinvaux <bgo@osimis.io>
parents:
3060
diff
changeset
|
34 .../boost/math/special_functions/round.hpp:93:11: note: in instantiation of function template specialization 'boost::math::iround<float, boost::math::policies::policy<boost::math::policies::default_policy, boost::math::policies::default_policy, boost::math::policies::default_policy, boost::math::policies::default_policy, boost::math::policies::default_policy, boost::math::policies::default_policy, boost::math::policies::default_policy, boost::math::policies::default_policy, boost::math::policies::default_policy, boost::math::policies::default_policy, boost::math::policies::default_policy> >' requested here |
|
113a9643e8bb
Suppressed a few warnings when building with emscripten (clang) + numeric truncation warnings
Benjamin Golinvaux <bgo@osimis.io>
parents:
3060
diff
changeset
|
35 .../orthanc/Core/JobsEngine/JobInfo.cpp:133:39: note: in instantiation of function template specialization 'boost::math::iround<float>' requested here |
|
113a9643e8bb
Suppressed a few warnings when building with emscripten (clang) + numeric truncation warnings
Benjamin Golinvaux <bgo@osimis.io>
parents:
3060
diff
changeset
|
36 */ |
|
113a9643e8bb
Suppressed a few warnings when building with emscripten (clang) + numeric truncation warnings
Benjamin Golinvaux <bgo@osimis.io>
parents:
3060
diff
changeset
|
37 #pragma GCC diagnostic ignored "-Wimplicit-int-float-conversion" |
|
113a9643e8bb
Suppressed a few warnings when building with emscripten (clang) + numeric truncation warnings
Benjamin Golinvaux <bgo@osimis.io>
parents:
3060
diff
changeset
|
38 #endif |
|
113a9643e8bb
Suppressed a few warnings when building with emscripten (clang) + numeric truncation warnings
Benjamin Golinvaux <bgo@osimis.io>
parents:
3060
diff
changeset
|
39 |
| 2569 | 40 #include "JobInfo.h" |
| 41 | |
| 42 #include "../OrthancException.h" | |
| 43 | |
| 2593 | 44 // This "include" is mandatory for Release builds using Linux Standard Base |
| 45 #include <boost/math/special_functions/round.hpp> | |
| 46 | |
| 2569 | 47 namespace Orthanc |
| 48 { | |
| 49 JobInfo::JobInfo(const std::string& id, | |
| 50 int priority, | |
| 51 JobState state, | |
| 52 const JobStatus& status, | |
| 53 const boost::posix_time::ptime& creationTime, | |
| 54 const boost::posix_time::ptime& lastStateChangeTime, | |
| 55 const boost::posix_time::time_duration& runtime) : | |
| 56 id_(id), | |
| 57 priority_(priority), | |
| 58 state_(state), | |
| 59 timestamp_(boost::posix_time::microsec_clock::universal_time()), | |
| 60 creationTime_(creationTime), | |
| 61 lastStateChangeTime_(lastStateChangeTime), | |
| 62 runtime_(runtime), | |
| 63 hasEta_(false), | |
| 64 status_(status) | |
| 65 { | |
| 66 if (state_ == JobState_Running) | |
| 67 { | |
| 68 float ms = static_cast<float>(runtime_.total_milliseconds()); | |
| 69 | |
| 70 if (status_.GetProgress() > 0.01f && | |
| 71 ms > 0.01f) | |
| 72 { | |
|
2573
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
73 float ratio = static_cast<float>(1.0 - status_.GetProgress()); |
|
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
74 long long remaining = boost::math::llround(ratio * ms); |
| 2569 | 75 eta_ = timestamp_ + boost::posix_time::milliseconds(remaining); |
| 76 hasEta_ = true; | |
| 77 } | |
| 78 } | |
| 79 } | |
| 80 | |
| 81 | |
| 82 JobInfo::JobInfo() : | |
| 83 priority_(0), | |
| 84 state_(JobState_Failure), | |
| 85 timestamp_(boost::posix_time::microsec_clock::universal_time()), | |
| 86 creationTime_(timestamp_), | |
| 87 lastStateChangeTime_(timestamp_), | |
| 88 runtime_(boost::posix_time::milliseconds(0)), | |
| 89 hasEta_(false) | |
| 90 { | |
| 91 } | |
| 92 | |
| 4300 | 93 const std::string &JobInfo::GetIdentifier() const |
| 94 { | |
| 95 return id_; | |
| 96 } | |
| 97 | |
| 98 int JobInfo::GetPriority() const | |
| 99 { | |
| 100 return priority_; | |
| 101 } | |
| 102 | |
| 103 JobState JobInfo::GetState() const | |
| 104 { | |
| 105 return state_; | |
| 106 } | |
| 107 | |
| 108 const boost::posix_time::ptime &JobInfo::GetInfoTime() const | |
| 109 { | |
| 110 return timestamp_; | |
| 111 } | |
| 112 | |
| 113 const boost::posix_time::ptime &JobInfo::GetCreationTime() const | |
| 114 { | |
| 115 return creationTime_; | |
| 116 } | |
| 117 | |
| 118 const boost::posix_time::time_duration &JobInfo::GetRuntime() const | |
| 119 { | |
| 120 return runtime_; | |
| 121 } | |
| 122 | |
| 123 bool JobInfo::HasEstimatedTimeOfArrival() const | |
| 124 { | |
| 125 return hasEta_; | |
| 126 } | |
| 127 | |
| 2569 | 128 |
| 129 bool JobInfo::HasCompletionTime() const | |
| 130 { | |
| 131 return (state_ == JobState_Success || | |
| 132 state_ == JobState_Failure); | |
| 133 } | |
| 134 | |
| 135 | |
| 136 const boost::posix_time::ptime& JobInfo::GetEstimatedTimeOfArrival() const | |
| 137 { | |
| 138 if (hasEta_) | |
| 139 { | |
| 140 return eta_; | |
| 141 } | |
| 142 else | |
| 143 { | |
| 144 throw OrthancException(ErrorCode_BadSequenceOfCalls); | |
| 145 } | |
| 146 } | |
| 147 | |
| 148 | |
| 149 const boost::posix_time::ptime& JobInfo::GetCompletionTime() const | |
| 150 { | |
| 151 if (HasCompletionTime()) | |
| 152 { | |
| 153 return lastStateChangeTime_; | |
| 154 } | |
| 155 else | |
| 156 { | |
| 157 throw OrthancException(ErrorCode_BadSequenceOfCalls); | |
| 158 } | |
| 159 } | |
| 160 | |
| 4300 | 161 const JobStatus &JobInfo::GetStatus() const |
| 162 { | |
| 163 return status_; | |
| 164 } | |
| 165 | |
| 166 JobStatus &JobInfo::GetStatus() | |
| 167 { | |
| 168 return status_; | |
| 169 } | |
| 170 | |
| 2569 | 171 |
|
2647
73d7d95dd75e
removal of internal job information
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2593
diff
changeset
|
172 void JobInfo::Format(Json::Value& target) const |
| 2569 | 173 { |
| 174 target = Json::objectValue; | |
| 175 target["ID"] = id_; | |
| 176 target["Priority"] = priority_; | |
| 177 target["ErrorCode"] = static_cast<int>(status_.GetErrorCode()); | |
| 178 target["ErrorDescription"] = EnumerationToString(status_.GetErrorCode()); | |
|
4667
08ee98bf103e
"/jobs/..." has new field "ErrorDetails" to help identify the cause of an error
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
179 target["ErrorDetails"] = status_.GetDetails(); |
| 2569 | 180 target["State"] = EnumerationToString(state_); |
| 181 target["Timestamp"] = boost::posix_time::to_iso_string(timestamp_); | |
| 182 target["CreationTime"] = boost::posix_time::to_iso_string(creationTime_); | |
|
2573
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
183 target["EffectiveRuntime"] = static_cast<double>(runtime_.total_milliseconds()) / 1000.0; |
| 2569 | 184 target["Progress"] = boost::math::iround(status_.GetProgress() * 100.0f); |
|
2573
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
185 |
|
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
186 target["Type"] = status_.GetJobType(); |
|
2647
73d7d95dd75e
removal of internal job information
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2593
diff
changeset
|
187 target["Content"] = status_.GetPublicContent(); |
| 2569 | 188 |
| 189 if (HasEstimatedTimeOfArrival()) | |
| 190 { | |
| 191 target["EstimatedTimeOfArrival"] = boost::posix_time::to_iso_string(GetEstimatedTimeOfArrival()); | |
| 192 } | |
| 193 | |
| 194 if (HasCompletionTime()) | |
| 195 { | |
| 196 target["CompletionTime"] = boost::posix_time::to_iso_string(GetCompletionTime()); | |
| 197 } | |
| 198 } | |
| 199 } |