-
Notifications
You must be signed in to change notification settings - Fork 122
/
Algorithm.cpp
1633 lines (1471 loc) · 58.3 KB
/
Algorithm.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/AlgorithmHistory.h"
#include "MantidAPI/AlgorithmProxy.h"
#include "MantidAPI/AnalysisDataService.h"
#include "MantidAPI/DeprecatedAlgorithm.h"
#include "MantidAPI/AlgorithmManager.h"
#include "MantidAPI/MemoryManager.h"
#include "MantidAPI/IWorkspaceProperty.h"
#include "MantidAPI/WorkspaceGroup.h"
#include "MantidAPI/MemoryManager.h"
#include "MantidKernel/EmptyValues.h"
#include "MantidKernel/DateAndTime.h"
#include "MantidKernel/MultiThreaded.h"
#include "MantidKernel/Strings.h"
#include "MantidKernel/Timer.h"
#include <boost/algorithm/string/trim.hpp>
#include <boost/algorithm/string/split.hpp>
#include <boost/algorithm/string/regex.hpp>
#include <boost/weak_ptr.hpp>
#include <Poco/ActiveMethod.h>
#include <Poco/ActiveResult.h>
#include <Poco/NotificationCenter.h>
#include <Poco/RWLock.h>
#include <Poco/StringTokenizer.h>
#include <Poco/Void.h>
#include <map>
using namespace Mantid::Kernel;
namespace Mantid {
namespace API {
namespace {
/// Separator for workspace types in workspaceMethodOnTypes member
const std::string WORKSPACE_TYPES_SEPARATOR = ";";
}
// Doxygen can't handle member specialization at the moment:
// https://bugzilla.gnome.org/show_bug.cgi?id=406027
// so we have to ignore them
///@cond
template <typename NumT> bool Algorithm::isEmpty(const NumT toCheck) {
return static_cast<int>(toCheck) == EMPTY_INT();
}
template <> MANTID_API_DLL bool Algorithm::isEmpty(const double toCheck) {
return std::abs((toCheck - EMPTY_DBL()) / (EMPTY_DBL())) < 1e-8;
}
// concrete instantiations
template MANTID_API_DLL bool Algorithm::isEmpty<int>(const int);
template MANTID_API_DLL bool Algorithm::isEmpty<int64_t>(const int64_t);
template MANTID_API_DLL bool Algorithm::isEmpty<std::size_t>(const std::size_t);
///@endcond
//=============================================================================================
//================================== Constructors/Destructors
//=================================
//=============================================================================================
/// Initialize static algorithm counter
size_t Algorithm::g_execCount = 0;
/// Constructor
Algorithm::Algorithm()
: PropertyManagerOwner(), m_cancel(false), m_parallelException(false),
m_log("Algorithm"), g_log(m_log), m_groupSize(0), m_executeAsync(NULL),
m_notificationCenter(NULL), m_progressObserver(NULL),
m_isInitialized(false), m_isExecuted(false), m_isChildAlgorithm(false),
m_recordHistoryForChild(false), m_alwaysStoreInADS(false),
m_runningAsync(false), m_running(false), m_rethrow(false),
m_isAlgStartupLoggingEnabled(true), m_startChildProgress(0.),
m_endChildProgress(0.), m_algorithmID(this), m_singleGroup(-1),
m_groupsHaveSimilarNames(false) {}
/// Virtual destructor
Algorithm::~Algorithm() {
delete m_notificationCenter;
delete m_executeAsync;
delete m_progressObserver;
// Free up any memory available.
Mantid::API::MemoryManager::Instance().releaseFreeMemory();
}
//=============================================================================================
//================================== Simple Getters/Setters
//===================================
//=============================================================================================
//---------------------------------------------------------------------------------------------
/// Has the Algorithm already been initialized
bool Algorithm::isInitialized() const { return m_isInitialized; }
/// Has the Algorithm already been executed
bool Algorithm::isExecuted() const { return m_isExecuted; }
//---------------------------------------------------------------------------------------------
/// Set the Algorithm initialized state
void Algorithm::setInitialized() { m_isInitialized = true; }
/** Set the executed flag to the specified state
// Public in Gaudi - don't know why and will leave here unless we find a reason
otherwise
// Also don't know reason for different return type and argument.
@param state :: New executed state
*/
void Algorithm::setExecuted(bool state) { m_isExecuted = state; }
//---------------------------------------------------------------------------------------------
/** To query whether algorithm is a child.
* @returns true - the algorithm is a child algorithm. False - this is a full
* managed algorithm.
*/
bool Algorithm::isChild() const { return m_isChildAlgorithm; }
/** To set whether algorithm is a child.
* @param isChild :: True - the algorithm is a child algorithm. False - this is
* a full managed algorithm.
*/
void Algorithm::setChild(const bool isChild) { m_isChildAlgorithm = isChild; }
/**
* Change the state of the history recording flag. Only applicable for
* child algorithms.
* @param on :: The new state of the flag
*/
void Algorithm::enableHistoryRecordingForChild(const bool on) {
m_recordHistoryForChild = on;
}
/** Do we ALWAYS store in the AnalysisDataService? This is set to true
* for python algorithms' child algorithms
*
* @param doStore :: always store in ADS
*/
void Algorithm::setAlwaysStoreInADS(const bool doStore) {
m_alwaysStoreInADS = doStore;
}
/** Set whether the algorithm will rethrow exceptions
* @param rethrow :: true if you want to rethrow exception.
*/
void Algorithm::setRethrows(const bool rethrow) { this->m_rethrow = rethrow; }
/// True if the algorithm is running.
bool Algorithm::isRunning() const {
Poco::FastMutex::ScopedLock _lock(m_mutex);
return m_running;
}
//---------------------------------------------------------------------------------------------
/** Add an observer to a notification
@param observer :: Reference to the observer to add
*/
void Algorithm::addObserver(const Poco::AbstractObserver &observer) const {
notificationCenter().addObserver(observer);
}
/** Remove an observer
@param observer :: Reference to the observer to remove
*/
void Algorithm::removeObserver(const Poco::AbstractObserver &observer) const {
notificationCenter().removeObserver(observer);
}
//---------------------------------------------------------------------------------------------
/** Sends ProgressNotification.
* @param p :: Reported progress, must be between 0 (just started) and 1
* (finished)
* @param msg :: Optional message string
* @param estimatedTime :: Optional estimated time to completion
* @param progressPrecision :: optional, int number of digits after the decimal
* point to show.
*/
void Algorithm::progress(double p, const std::string &msg, double estimatedTime,
int progressPrecision) {
notificationCenter().postNotification(
new ProgressNotification(this, p, msg, estimatedTime, progressPrecision));
}
//---------------------------------------------------------------------------------------------
/// Function to return all of the categories that contain this algorithm
const std::vector<std::string> Algorithm::categories() const {
std::vector<std::string> res;
Poco::StringTokenizer tokenizer(category(), categorySeparator(),
Poco::StringTokenizer::TOK_TRIM |
Poco::StringTokenizer::TOK_IGNORE_EMPTY);
Poco::StringTokenizer::Iterator h = tokenizer.begin();
for (; h != tokenizer.end(); ++h) {
res.push_back(*h);
}
const DeprecatedAlgorithm *depo =
dynamic_cast<const DeprecatedAlgorithm *>(this);
if (depo != NULL) {
res.push_back("Deprecated");
}
return res;
}
/**
* @return A string giving the method name that should be attached to a
* workspace
*/
const std::string Algorithm::workspaceMethodName() const { return ""; }
/**
*
* @return A list of workspace class names that should have the
*workspaceMethodName attached
*/
const std::vector<std::string> Algorithm::workspaceMethodOn() const {
Poco::StringTokenizer tokenizer(this->workspaceMethodOnTypes(),
WORKSPACE_TYPES_SEPARATOR,
Poco::StringTokenizer::TOK_TRIM |
Poco::StringTokenizer::TOK_IGNORE_EMPTY);
std::vector<std::string> res;
res.reserve(tokenizer.count());
for (auto iter = tokenizer.begin(); iter != tokenizer.end(); ++iter) {
res.push_back(*iter);
}
return res;
}
/**
* @return The name of the property that the calling object will be passed to.
*/
const std::string Algorithm::workspaceMethodInputProperty() const { return ""; }
//=============================================================================================
//================================== Initialization
//===========================================
//=============================================================================================
//---------------------------------------------------------------------------------------------
/** Initialization method invoked by the framework. This method is responsible
* for any bookkeeping of initialization required by the framework itself.
* It will in turn invoke the init() method of the derived algorithm,
* and of any Child Algorithms which it creates.
* @throw runtime_error Thrown if algorithm or Child Algorithm cannot be
*initialised
*
*/
void Algorithm::initialize() {
// Bypass the initialization if the algorithm has already been initialized.
if (m_isInitialized)
return;
g_log.setName(this->name());
try {
try {
this->init();
} catch (std::runtime_error &) {
throw;
}
// Indicate that this Algorithm has been initialized to prevent duplicate
// attempts.
setInitialized();
} catch (std::runtime_error &) {
throw;
}
// Unpleasant catch-all! Along with this, Gaudi version catches GaudiException
// & std::exception
// but doesn't really do anything except (print fatal) messages.
catch (...) {
// Gaudi: A call to the auditor service is here
// (1) perform the printout
getLogger().fatal("UNKNOWN Exception is caught in initialize()");
throw;
}
}
//---------------------------------------------------------------------------------------------
/** Perform validation of ALL the input properties of the algorithm.
* This is to be overridden by specific algorithms.
* It will be called in dialogs after parsing all inputs and setting the
* properties, but BEFORE executing.
*
* @return a map where: Key = string name of the the property;
Value = string describing the problem with the property.
*/
std::map<std::string, std::string> Algorithm::validateInputs() {
return std::map<std::string, std::string>();
}
//---------------------------------------------------------------------------------------------
/** Go through the properties and cache the input/output
* workspace properties for later use.
*/
void Algorithm::cacheWorkspaceProperties() {
// Cache the list of the in/out workspace properties
m_inputWorkspaceProps.clear();
m_outputWorkspaceProps.clear();
m_pureOutputWorkspaceProps.clear();
const std::vector<Property *> &props = this->getProperties();
for (size_t i = 0; i < props.size(); i++) {
Property *prop = props[i];
IWorkspaceProperty *wsProp = dynamic_cast<IWorkspaceProperty *>(prop);
if (wsProp) {
switch (prop->direction()) {
case Kernel::Direction::Input:
m_inputWorkspaceProps.push_back(wsProp);
break;
case Kernel::Direction::InOut:
m_inputWorkspaceProps.push_back(wsProp);
m_outputWorkspaceProps.push_back(wsProp);
break;
case Kernel::Direction::Output:
m_outputWorkspaceProps.push_back(wsProp);
m_pureOutputWorkspaceProps.push_back(wsProp);
break;
default:
throw std::logic_error(
"Unexpected property direction found for property " + prop->name() +
" of algorithm " + this->name());
}
} // is a ws property
} // each property
}
//=============================================================================================
//================================== Execution
//================================================
//=============================================================================================
//---------------------------------------------------------------------------------------------
/** Go through the workspace properties of this algorithm
* and lock the workspaces for reading or writing.
*
*/
void Algorithm::lockWorkspaces() {
// Do not lock workspace for child algos
if (this->isChild())
return;
if (!m_readLockedWorkspaces.empty() || !m_writeLockedWorkspaces.empty())
throw std::logic_error("Algorithm::lockWorkspaces(): The workspaces have "
"already been locked!");
// First, Write-lock the output workspaces
auto &debugLog = g_log.debug();
for (size_t i = 0; i < m_outputWorkspaceProps.size(); i++) {
Workspace_sptr ws = m_outputWorkspaceProps[i]->getWorkspace();
if (ws) {
// The workspace property says to do locking,
// AND it has NOT already been write-locked
if (m_outputWorkspaceProps[i]->isLocking() &&
std::find(m_writeLockedWorkspaces.begin(),
m_writeLockedWorkspaces.end(),
ws) == m_writeLockedWorkspaces.end()) {
// Write-lock it if not already
debugLog << "Write-locking " << ws->getName() << std::endl;
ws->getLock()->writeLock();
m_writeLockedWorkspaces.push_back(ws);
}
}
}
// Next read-lock the input workspaces
for (size_t i = 0; i < m_inputWorkspaceProps.size(); i++) {
Workspace_sptr ws = m_inputWorkspaceProps[i]->getWorkspace();
if (ws) {
// The workspace property says to do locking,
// AND it has NOT already been write-locked
if (m_inputWorkspaceProps[i]->isLocking() &&
std::find(m_writeLockedWorkspaces.begin(),
m_writeLockedWorkspaces.end(),
ws) == m_writeLockedWorkspaces.end()) {
// Read-lock it if not already write-locked
debugLog << "Read-locking " << ws->getName() << std::endl;
ws->getLock()->readLock();
m_readLockedWorkspaces.push_back(ws);
}
}
}
}
//---------------------------------------------------------------------------------------------
/** Unlock any previously locked workspaces
*
*/
void Algorithm::unlockWorkspaces() {
// Do not lock workspace for child algos
if (this->isChild())
return;
auto &debugLog = g_log.debug();
for (size_t i = 0; i < m_writeLockedWorkspaces.size(); i++) {
Workspace_sptr ws = m_writeLockedWorkspaces[i];
if (ws) {
debugLog << "Unlocking " << ws->getName() << std::endl;
ws->getLock()->unlock();
}
}
for (size_t i = 0; i < m_readLockedWorkspaces.size(); i++) {
Workspace_sptr ws = m_readLockedWorkspaces[i];
if (ws) {
debugLog << "Unlocking " << ws->getName() << std::endl;
ws->getLock()->unlock();
}
}
// Don't double-unlock workspaces
m_readLockedWorkspaces.clear();
m_writeLockedWorkspaces.clear();
}
//---------------------------------------------------------------------------------------------
/** The actions to be performed by the algorithm on a dataset. This method is
* invoked for top level algorithms by the application manager.
* This method invokes exec() method.
* For Child Algorithms either the execute() method or exec() method
* must be EXPLICITLY invoked by the parent algorithm.
*
* @throw runtime_error Thrown if algorithm or Child Algorithm cannot be
*executed
* @return true if executed successfully.
*/
bool Algorithm::execute() {
AlgorithmManager::Instance().notifyAlgorithmStarting(this->getAlgorithmID());
{
DeprecatedAlgorithm *depo = dynamic_cast<DeprecatedAlgorithm *>(this);
if (depo != NULL)
getLogger().error(depo->deprecationMsg(this));
}
// Start by freeing up any memory available.
Mantid::API::MemoryManager::Instance().releaseFreeMemory();
notificationCenter().postNotification(new StartedNotification(this));
Mantid::Kernel::DateAndTime start_time;
// Return a failure if the algorithm hasn't been initialized
if (!isInitialized()) {
throw std::runtime_error("Algorithm is not initialised:" + this->name());
}
// Cache the workspace in/out properties for later use
cacheWorkspaceProperties();
// no logging of input if a child algorithm (except for python child algos)
if (!m_isChildAlgorithm || m_alwaysStoreInADS)
logAlgorithmInfo();
// Check all properties for validity
if (!validateProperties()) {
// Reset name on input workspaces to trigger attempt at collection from ADS
const std::vector<Property *> &props = getProperties();
for (unsigned int i = 0; i < props.size(); ++i) {
IWorkspaceProperty *wsProp = dynamic_cast<IWorkspaceProperty *>(props[i]);
if (wsProp && !(wsProp->getWorkspace())) {
// Setting it's name to the same one it already had
props[i]->setValue(props[i]->value());
}
}
// Try the validation again
if (!validateProperties()) {
notificationCenter().postNotification(
new ErrorNotification(this, "Some invalid Properties found"));
throw std::runtime_error("Some invalid Properties found");
}
}
// ----- Check for processing groups -------------
// default true so that it has the right value at the check below the catch
// block should checkGroups throw
bool callProcessGroups = true;
try {
// Checking the input is a group. Throws if the sizes are wrong
callProcessGroups = this->checkGroups();
} catch (std::exception &ex) {
getLogger().error() << "Error in execution of algorithm " << this->name()
<< "\n" << ex.what() << "\n";
notificationCenter().postNotification(
new ErrorNotification(this, ex.what()));
m_running = false;
if (m_isChildAlgorithm || m_runningAsync || m_rethrow) {
m_runningAsync = false;
throw;
}
return false;
}
// ----- Perform validation of the whole set of properties -------------
if (!callProcessGroups) // for groups this is called on each workspace
// separately
{
std::map<std::string, std::string> errors = this->validateInputs();
if (!errors.empty()) {
size_t numErrors = errors.size();
// Log each issue
auto &errorLog = getLogger().error();
auto &warnLog = getLogger().warning();
for (auto it = errors.begin(); it != errors.end(); it++) {
if (this->existsProperty(it->first))
errorLog << "Invalid value for " << it->first << ": " << it->second
<< "\n";
else {
numErrors -= 1; // don't count it as an error
warnLog << "validateInputs() references non-existant property \""
<< it->first << "\"\n";
}
}
// Throw because something was invalid
if (numErrors > 0) {
notificationCenter().postNotification(
new ErrorNotification(this, "Some invalid Properties found"));
throw std::runtime_error("Some invalid Properties found");
}
}
}
if (trackingHistory()) {
// count used for defining the algorithm execution order
// If history is being recorded we need to count this as a separate
// algorithm
// as the history compares histories by their execution number
++Algorithm::g_execCount;
// populate history record before execution so we can record child
// algorithms in it
AlgorithmHistory algHist;
m_history = boost::make_shared<AlgorithmHistory>(algHist);
}
// ----- Process groups -------------
// If checkGroups() threw an exception but there ARE group workspaces
// (means that the group sizes were incompatible)
if (callProcessGroups) {
// This calls this->execute() again on each member of the group.
start_time = Mantid::Kernel::DateAndTime::getCurrentTime();
// Start a timer
Timer timer;
// Call the concrete algorithm's exec method
const bool completed = processGroups();
// Check for a cancellation request in case the concrete algorithm doesn't
interruption_point();
// Get how long this algorithm took to run
const float duration = timer.elapsed();
if (completed) {
// Log that execution has completed.
reportCompleted(duration,
true /*indicat that this is for group processing*/);
}
return completed;
}
// Read or write locks every input/output workspace
this->lockWorkspaces();
// Invoke exec() method of derived class and catch all uncaught exceptions
try {
try {
if (!isChild()) {
Poco::FastMutex::ScopedLock _lock(m_mutex);
m_running = true;
}
start_time = Mantid::Kernel::DateAndTime::getCurrentTime();
// Start a timer
Timer timer;
// Call the concrete algorithm's exec method
this->exec();
// Check for a cancellation request in case the concrete algorithm doesn't
interruption_point();
// Get how long this algorithm took to run
const float duration = timer.elapsed();
// need it to throw before trying to run fillhistory() on an algorithm
// which has failed
if (trackingHistory() && m_history) {
m_history->fillAlgorithmHistory(this, start_time, duration,
Algorithm::g_execCount);
fillHistory();
linkHistoryWithLastChild();
}
// Put any output workspaces into the AnalysisDataService - if this is not
// a child algorithm
if (!isChild() || m_alwaysStoreInADS)
this->store();
// RJT, 19/3/08: Moved this up from below the catch blocks
setExecuted(true);
// Log that execution has completed.
reportCompleted(duration);
} catch (std::runtime_error &ex) {
this->unlockWorkspaces();
if (m_isChildAlgorithm || m_runningAsync || m_rethrow)
throw;
else {
getLogger().error() << "Error in execution of algorithm "
<< this->name() << std::endl << ex.what()
<< std::endl;
}
notificationCenter().postNotification(
new ErrorNotification(this, ex.what()));
m_running = false;
} catch (std::logic_error &ex) {
this->unlockWorkspaces();
if (m_isChildAlgorithm || m_runningAsync || m_rethrow)
throw;
else {
getLogger().error() << "Logic Error in execution of algorithm "
<< this->name() << std::endl << ex.what()
<< std::endl;
}
notificationCenter().postNotification(
new ErrorNotification(this, ex.what()));
m_running = false;
}
} catch (CancelException &ex) {
m_runningAsync = false;
m_running = false;
getLogger().error() << this->name() << ": Execution terminated by user.\n";
notificationCenter().postNotification(
new ErrorNotification(this, ex.what()));
this->unlockWorkspaces();
throw;
}
// Gaudi also specifically catches GaudiException & std:exception.
catch (std::exception &ex) {
setExecuted(false);
m_runningAsync = false;
m_running = false;
notificationCenter().postNotification(
new ErrorNotification(this, ex.what()));
getLogger().error() << "Error in execution of algorithm " << this->name()
<< ":\n" << ex.what() << "\n";
this->unlockWorkspaces();
throw;
}
catch (...) {
// Execution failed
setExecuted(false);
m_runningAsync = false;
m_running = false;
notificationCenter().postNotification(
new ErrorNotification(this, "UNKNOWN Exception is caught in exec()"));
getLogger().error() << this->name()
<< ": UNKNOWN Exception is caught in exec()\n";
this->unlockWorkspaces();
throw;
}
// Unlock the locked workspaces
this->unlockWorkspaces();
notificationCenter().postNotification(
new FinishedNotification(this, isExecuted()));
// Only gets to here if algorithm ended normally
// Free up any memory available.
Mantid::API::MemoryManager::Instance().releaseFreeMemory();
return isExecuted();
}
//---------------------------------------------------------------------------------------------
/** Execute as a Child Algorithm.
* This runs execute() but catches errors so as to log the name
* of the failed Child Algorithm, if it fails.
*/
void Algorithm::executeAsChildAlg() {
bool executed = false;
try {
executed = execute();
} catch (std::runtime_error &) {
throw;
}
if (!executed) {
throw std::runtime_error("Unable to successfully run ChildAlgorithm " +
this->name());
}
}
//---------------------------------------------------------------------------------------------
/** Stores any output workspaces into the AnalysisDataService
* @throw std::runtime_error If unable to successfully store an output workspace
*/
void Algorithm::store() {
const std::vector<Property *> &props = getProperties();
std::vector<int> groupWsIndicies;
// add any regular/child workspaces first, then add the groups
for (unsigned int i = 0; i < props.size(); ++i) {
IWorkspaceProperty *wsProp = dynamic_cast<IWorkspaceProperty *>(props[i]);
if (wsProp) {
// check if the workspace is a group, if so remember where it is and add
// it later
auto group =
boost::dynamic_pointer_cast<WorkspaceGroup>(wsProp->getWorkspace());
if (!group) {
try {
wsProp->store();
} catch (std::runtime_error &) {
throw;
}
} else {
groupWsIndicies.push_back(i);
}
}
}
// now store workspace groups once their members have been added
std::vector<int>::const_iterator wsIndex;
for (wsIndex = groupWsIndicies.begin(); wsIndex != groupWsIndicies.end();
++wsIndex) {
IWorkspaceProperty *wsProp =
dynamic_cast<IWorkspaceProperty *>(props[*wsIndex]);
if (wsProp) {
try {
wsProp->store();
} catch (std::runtime_error &) {
throw;
}
}
}
}
//---------------------------------------------------------------------------------------------
/** Create a Child Algorithm. A call to this method creates a child algorithm
*object.
* Using this mechanism instead of creating daughter
* algorithms directly via the new operator is prefered since then
* the framework can take care of all of the necessary book-keeping.
*
* @param name :: The concrete algorithm class of the Child Algorithm
* @param startProgress :: The percentage progress value of the overall
*algorithm where this child algorithm starts
* @param endProgress :: The percentage progress value of the overall
*algorithm where this child algorithm ends
* @param enableLogging :: Set to false to disable logging from the child
*algorithm
* @param version :: The version of the child algorithm to create. By
*default gives the latest version.
* @return shared pointer to the newly created algorithm object
*/
Algorithm_sptr Algorithm::createChildAlgorithm(const std::string &name,
const double startProgress,
const double endProgress,
const bool enableLogging,
const int &version) {
Algorithm_sptr alg =
AlgorithmManager::Instance().createUnmanaged(name, version);
// set as a child
alg->setChild(true);
alg->setLogging(enableLogging);
// Initialise the Child Algorithm
try {
alg->initialize();
} catch (std::runtime_error &) {
throw std::runtime_error("Unable to initialise Child Algorithm '" + name +
"'");
}
// If output workspaces are nameless, give them a temporary name to satisfy
// validator
const std::vector<Property *> &props = alg->getProperties();
for (unsigned int i = 0; i < props.size(); ++i) {
auto wsProp = dynamic_cast<IWorkspaceProperty *>(props[i]);
if (props[i]->direction() == Mantid::Kernel::Direction::Output && wsProp) {
if (props[i]->value().empty()) {
props[i]->createTemporaryValue();
}
}
}
if (startProgress >= 0 && endProgress > startProgress && endProgress <= 1.) {
alg->addObserver(this->progressObserver());
m_startChildProgress = startProgress;
m_endChildProgress = endProgress;
}
// Before we return the shared pointer, use it to create a weak pointer and
// keep that in a vector.
// It will be used this to pass on cancellation requests
// It must be protected by a critical block so that Child Algorithms can run
// in parallel safely.
boost::weak_ptr<IAlgorithm> weakPtr(alg);
PARALLEL_CRITICAL(Algorithm_StoreWeakPtr) {
m_ChildAlgorithms.push_back(weakPtr);
}
return alg;
}
//=============================================================================================
//================================== Algorithm History
//========================================
//=============================================================================================
/**
* Serialize this object to a string. The format is
* AlgorithmName.version(prop1=value1,prop2=value2,...)
* @returns This object serialized as a string
*/
std::string Algorithm::toString() const {
std::ostringstream writer;
writer << name() << "." << this->version() << "("
<< Kernel::PropertyManagerOwner::asString(false) << ")";
return writer.str();
}
//--------------------------------------------------------------------------------------------
/** Construct an object from a history entry.
*
* This creates the algorithm and sets all of its properties using the history.
*
* @param history :: AlgorithmHistory object
* @return a shared pointer to the created algorithm.
*/
IAlgorithm_sptr Algorithm::fromHistory(const AlgorithmHistory &history) {
// Hand off to the string creator
std::ostringstream stream;
stream << history.name() << "." << history.version() << "(";
auto props = history.getProperties();
const size_t numProps(props.size());
for (size_t i = 0; i < numProps; ++i) {
PropertyHistory_sptr prop = props[i];
if (!prop->isDefault()) {
stream << prop->name() << "=" << prop->value();
}
if (i < numProps - 1)
stream << ",";
}
stream << ")";
IAlgorithm_sptr alg;
try {
alg = Algorithm::fromString(stream.str());
} catch (std::invalid_argument &) {
throw std::runtime_error(
"Could not create algorithm from history. "
"Is this a child algorithm whose workspaces are not in the ADS?");
}
return alg;
}
//--------------------------------------------------------------------------------------------
/** De-serializes the algorithm from a string
*
* @param input :: An input string in the format. The format is
* AlgorithmName.version(prop1=value1,prop2=value2,...). If .version is
*not found the
* highest found is used.
* @return A pointer to a managed algorithm object
*/
IAlgorithm_sptr Algorithm::fromString(const std::string &input) {
static const boost::regex nameExp("(^[[:alnum:]]*)");
// Double back slash gets rid of the compiler warning about unrecognized
// escape sequence
static const boost::regex versExp("\\.([[:digit:]]+)\\(*");
// Property regex. Simply match the brackets and split
static const boost::regex propExp("\\((.*)\\)");
// Name=Value regex
static const boost::regex nameValExp("(.*)=(.*)");
// Property name regex
static const boost::regex propNameExp(".*,([[:word:]]*)");
// Empty dividers
static const boost::regex emptyExp(",[ ,]*,");
// Trailing commas
static const boost::regex trailingCommaExp(",$");
boost::match_results<std::string::const_iterator> what;
if (boost::regex_search(input, what, nameExp, boost::match_not_null)) {
const std::string algName = what[1];
int version = -1; // Highest version
if (boost::regex_search(input, what, versExp, boost::match_not_null)) {
try {
version = boost::lexical_cast<int, std::string>(what.str(1));
} catch (boost::bad_lexical_cast &) {
}
}
IAlgorithm_sptr alg =
AlgorithmManager::Instance().createUnmanaged(algName, version);
alg->initialize();
if (boost::regex_search(input, what, propExp, boost::match_not_null)) {
std::string _propStr = what[1];
// Cleanup: Remove empty dividers (multiple commas)
std::string __propStr = regex_replace(_propStr, emptyExp, ",");
// Cleanup: We might still be left with a trailing comma, remove it
std::string propStr = regex_replace(__propStr, trailingCommaExp, "");
boost::match_flag_type flags = boost::match_not_null;
std::string::const_iterator start, end;
start = propStr.begin();
end = propStr.end();
// Accumulate them first so that we can set some out of order
std::map<std::string, std::string> propNameValues;
while (boost::regex_search(start, end, what, nameValExp, flags)) {
std::string nameValue = what.str(1);
std::string value = what.str(2);
if (boost::regex_search(what[1].first, what[1].second, what,
propNameExp, boost::match_not_null)) {
const std::string name = what.str(1);
propNameValues[name] = value;
end = what[1].first - 1;
} else {
// The last property-value pair
propNameValues[nameValue] = value;
break;
}
// update flags:
flags |= boost::match_prev_avail;
flags |= boost::match_not_bob;
}
// Some algorithms require Filename to be set first do that here
auto it = propNameValues.find("Filename");
if (it != propNameValues.end()) {
alg->setPropertyValue(it->first, it->second);
propNameValues.erase(it);
}
for (auto cit = propNameValues.begin(); cit != propNameValues.end();
++cit) {
alg->setPropertyValue(cit->first, cit->second);
}
}
return alg;
} else {
throw std::runtime_error("Cannot create algorithm, invalid string format.");
}
}
//-------------------------------------------------------------------------
/** Initialize using proxy algorithm.
* Call the main initialize method and then copy in the property values.
* @param proxy :: Initialising proxy algorithm */
void Algorithm::initializeFromProxy(const AlgorithmProxy &proxy) {
initialize();
copyPropertiesFrom(proxy);
m_algorithmID = proxy.getAlgorithmID();
setLogging(proxy.isLogging());
setLoggingOffset(proxy.getLoggingOffset());
setAlgStartupLogging(proxy.getAlgStartupLogging());
setChild(proxy.isChild());
}
/** Fills History, Algorithm History and Algorithm Parameters
*/
void Algorithm::fillHistory() {
// this is not a child algorithm. Add the history algorithm to the
// WorkspaceHistory object.
if (!isChild()) {
// Create two vectors to hold a list of pointers to the input & output
// workspaces (InOut's go in both)
std::vector<Workspace_sptr> inputWorkspaces, outputWorkspaces;
std::vector<Workspace_sptr>::iterator outWS;
std::vector<Workspace_sptr>::const_iterator inWS;
findWorkspaceProperties(inputWorkspaces, outputWorkspaces);
// Loop over the output workspaces
for (outWS = outputWorkspaces.begin(); outWS != outputWorkspaces.end();
++outWS) {
WorkspaceGroup_sptr wsGroup =
boost::dynamic_pointer_cast<WorkspaceGroup>(*outWS);
// Loop over the input workspaces, making the call that copies their
// history to the output ones
// (Protection against copy to self is in
// WorkspaceHistory::copyAlgorithmHistory)
for (inWS = inputWorkspaces.begin(); inWS != inputWorkspaces.end();
++inWS) {
(*outWS)->history().addHistory((*inWS)->getHistory());
// Add history to each child of output workspace group
if (wsGroup) {
for (size_t i = 0; i < wsGroup->size(); i++) {
wsGroup->getItem(i)->history().addHistory((*inWS)->getHistory());
}
}
}
// Add the history for the current algorithm to all the output workspaces
(*outWS)->history().addHistory(m_history);
// Add history to each child of output workspace group
if (wsGroup) {
for (size_t i = 0; i < wsGroup->size(); i++) {
wsGroup->getItem(i)->history().addHistory(m_history);
}
}
}