Algorithm.cpp 73.1 KB
Newer Older
1
2
3
4
5
6
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
//     NScD Oak Ridge National Laboratory, European Spallation Source
//     & Institut Laue - Langevin
// SPDX - License - Identifier: GPL - 3.0 +
7
#include "MantidAPI/Algorithm.h"
8
#include "MantidAPI/ADSValidator.h"
9
#include "MantidAPI/AlgorithmHistory.h"
10
#include "MantidAPI/AlgorithmManager.h"
11
#include "MantidAPI/AlgorithmProxy.h"
12
#include "MantidAPI/AnalysisDataService.h"
13
#include "MantidAPI/DeprecatedAlgorithm.h"
14
#include "MantidAPI/IWorkspaceProperty.h"
15
#include "MantidAPI/WorkspaceGroup.h"
16
#include "MantidAPI/WorkspaceHistory.h"
17

18
#include "MantidKernel/CompositeValidator.h"
Nick Draper's avatar
Nick Draper committed
19
#include "MantidKernel/ConfigService.h"
20
#include "MantidKernel/DateAndTime.h"
21
#include "MantidKernel/EmptyValues.h"
22
#include "MantidKernel/MultiThreaded.h"
23
#include "MantidKernel/PropertyWithValue.h"
24
#include "MantidKernel/Strings.h"
25
#include "MantidKernel/Timer.h"
Nick Draper's avatar
Nick Draper committed
26
#include "MantidKernel/UsageService.h"
27

28
29
#include "MantidParallel/Communicator.h"

30
#include <boost/weak_ptr.hpp>
31

32
#include <MantidKernel/StringTokenizer.h>
33
34
35
#include <Poco/ActiveMethod.h>
#include <Poco/ActiveResult.h>
#include <Poco/NotificationCenter.h>
36
#include <Poco/RWLock.h>
37
#include <Poco/Void.h>
Nick Draper's avatar
Nick Draper committed
38

39
#include <json/json.h>
40

41
#include <map>
42

LamarMoore's avatar
LamarMoore committed
43
44
45
// Index property handling template definitions
#include "MantidAPI/Algorithm.tcc"

46
47
using namespace Mantid::Kernel;

48
49
50
51
52
namespace Mantid {
namespace API {
namespace {
/// Separator for workspace types in workspaceMethodOnTypes member
const std::string WORKSPACE_TYPES_SEPARATOR = ";";
53
54
55

class WorkspacePropertyValueIs {
public:
56
57
  explicit WorkspacePropertyValueIs(const std::string &value)
      : m_value(value){};
Dan Nixon's avatar
Dan Nixon committed
58
59
  bool operator()(IWorkspaceProperty *property) {
    Property *prop = dynamic_cast<Property *>(property);
60
61
62
63
64
65
    if (!prop)
      return false;
    return prop->value() == m_value;
  }

private:
66
  const std::string &m_value;
67
};
68
} // namespace
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

// 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),
99
100
      m_log("Algorithm"), g_log(m_log), m_groupSize(0), m_executeAsync(nullptr),
      m_notificationCenter(nullptr), m_progressObserver(nullptr),
101
      m_isInitialized(false), m_isExecuted(false), m_isChildAlgorithm(false),
102
      m_recordHistoryForChild(false), m_alwaysStoreInADS(true),
103
      m_runningAsync(false), m_running(false), m_rethrow(false),
104
105
      m_isAlgStartupLoggingEnabled(true), m_startChildProgress(0.),
      m_endChildProgress(0.), m_algorithmID(this), m_singleGroup(-1),
106
107
      m_groupsHaveSimilarNames(false),
      m_communicator(Kernel::make_unique<Parallel::Communicator>()) {}
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

/// Virtual destructor
Algorithm::~Algorithm() {
  delete m_notificationCenter;
  delete m_executeAsync;
  delete m_progressObserver;
}

//=============================================================================================
//================================== 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.
142
143
144
 *  @returns true - the algorithm is a child algorithm.  False - this is a full
 * managed algorithm.
 */
145
146
147
bool Algorithm::isChild() const { return m_isChildAlgorithm; }

/** To set whether algorithm is a child.
148
149
150
 *  @param isChild :: True - the algorithm is a child algorithm.  False - this
 * is a full managed algorithm.
 */
151
void Algorithm::setChild(const bool isChild) {
Gagik Vardanyan's avatar
Gagik Vardanyan committed
152
153
  m_isChildAlgorithm = isChild;
  this->setAlwaysStoreInADS(!isChild);
154
}
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

/**
 * 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;
}

174
175
176
177
178
/** Returns true if we always store in the AnalysisDataService.
 *  @return true if output is saved to the AnalysisDataService.
 */
bool Algorithm::getAlwaysStoreInADS() const { return m_alwaysStoreInADS; }

179
180
181
182
183
184
/** 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.
185
bool Algorithm::isRunning() const { return m_running; }
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209

//---------------------------------------------------------------------------------------------
/**  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.
210
 */
211
212
213
214
215
216
217
218
219
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 {
220
221
222
223
  Mantid::Kernel::StringTokenizer tokenizer(
      category(), categorySeparator(),
      Mantid::Kernel::StringTokenizer::TOK_TRIM |
          Mantid::Kernel::StringTokenizer::TOK_IGNORE_EMPTY);
224

225
  auto res = tokenizer.asVector();
226

227
228
  const DeprecatedAlgorithm *depo =
      dynamic_cast<const DeprecatedAlgorithm *>(this);
229
  if (depo != nullptr) {
230
    res.emplace_back("Deprecated");
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
  }
  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 {
247
248
249
250
  Mantid::Kernel::StringTokenizer tokenizer(
      this->workspaceMethodOnTypes(), WORKSPACE_TYPES_SEPARATOR,
      Mantid::Kernel::StringTokenizer::TOK_TRIM |
          Mantid::Kernel::StringTokenizer::TOK_IGNORE_EMPTY);
251
  return tokenizer.asVector();
252
253
254
255
256
257
258
259
260
261
262
263
264
265
}

/**
 * @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
266
267
268
269
270
271
272
 *  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
 *
 */
273
274
275
276
277
278
void Algorithm::initialize() {
  // Bypass the initialization if the algorithm has already been initialized.
  if (m_isInitialized)
    return;

  g_log.setName(this->name());
279
  setLoggingOffset(0);
280
281
282
  try {
    try {
      this->init();
283
      setupSkipValidationMasterOnly();
284
285
    } catch (std::runtime_error &) {
      throw;
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
    // 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();
328
  for (auto prop : props) {
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
    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());
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
    } // 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();
Hahn, Steven's avatar
Hahn, Steven committed
373
374
  for (auto &outputWorkspaceProp : m_outputWorkspaceProps) {
    Workspace_sptr ws = outputWorkspaceProp->getWorkspace();
375
376
377
    if (ws) {
      // The workspace property says to do locking,
      // AND it has NOT already been write-locked
Hahn, Steven's avatar
Hahn, Steven committed
378
      if (outputWorkspaceProp->isLocking() &&
379
380
381
382
          std::find(m_writeLockedWorkspaces.begin(),
                    m_writeLockedWorkspaces.end(),
                    ws) == m_writeLockedWorkspaces.end()) {
        // Write-lock it if not already
383
        debugLog << "Write-locking " << ws->getName() << '\n';
384
385
        ws->getLock()->writeLock();
        m_writeLockedWorkspaces.push_back(ws);
386
387
      }
    }
388
  }
389

390
  // Next read-lock the input workspaces
Hahn, Steven's avatar
Hahn, Steven committed
391
392
  for (auto &inputWorkspaceProp : m_inputWorkspaceProps) {
    Workspace_sptr ws = inputWorkspaceProp->getWorkspace();
393
394
395
    if (ws) {
      // The workspace property says to do locking,
      // AND it has NOT already been write-locked
Hahn, Steven's avatar
Hahn, Steven committed
396
      if (inputWorkspaceProp->isLocking() &&
397
398
399
400
          std::find(m_writeLockedWorkspaces.begin(),
                    m_writeLockedWorkspaces.end(),
                    ws) == m_writeLockedWorkspaces.end()) {
        // Read-lock it if not already write-locked
401
        debugLog << "Read-locking " << ws->getName() << '\n';
402
403
404
        ws->getLock()->readLock();
        m_readLockedWorkspaces.push_back(ws);
      }
405
    }
406
407
408
409
410
411
412
413
414
415
416
417
  }
}

//---------------------------------------------------------------------------------------------
/** Unlock any previously locked workspaces
 *
 */
void Algorithm::unlockWorkspaces() {
  // Do not lock workspace for child algos
  if (this->isChild())
    return;
  auto &debugLog = g_log.debug();
418
  for (auto &ws : m_writeLockedWorkspaces) {
419
    if (ws) {
420
      debugLog << "Unlocking " << ws->getName() << '\n';
421
      ws->getLock()->unlock();
422
    }
423
  }
424
  for (auto &ws : m_readLockedWorkspaces) {
425
    if (ws) {
426
      debugLog << "Unlocking " << ws->getName() << '\n';
427
      ws->getLock()->unlock();
428
    }
429
  }
430

431
432
433
434
435
436
  // Don't double-unlock workspaces
  m_readLockedWorkspaces.clear();
  m_writeLockedWorkspaces.clear();
}

//---------------------------------------------------------------------------------------------
437
/** Invoced internally in execute()
438
 */
439
440

bool Algorithm::executeInternal() {
441
  Timer timer;
442
443
444
  AlgorithmManager::Instance().notifyAlgorithmStarting(this->getAlgorithmID());
  {
    DeprecatedAlgorithm *depo = dynamic_cast<DeprecatedAlgorithm *>(this);
445
    if (depo != nullptr)
446
447
      getLogger().error(depo->deprecationMsg(this));
  }
448

449
  notificationCenter().postNotification(new StartedNotification(this));
450
  Mantid::Types::Core::DateAndTime startTime;
Nick Draper's avatar
Nick Draper committed
451

452
453
454
455
456
457
458
459
460
461
462
463
464
  // 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
465
466
  constexpr bool resetTimer{true};
  float timingInit = timer.elapsed(resetTimer);
467
468
469
  if (!validateProperties()) {
    // Reset name on input workspaces to trigger attempt at collection from ADS
    const std::vector<Property *> &props = getProperties();
Hahn, Steven's avatar
Hahn, Steven committed
470
    for (auto &prop : props) {
471
      IWorkspaceProperty *wsProp = dynamic_cast<IWorkspaceProperty *>(prop);
472
473
      if (wsProp && !(wsProp->getWorkspace())) {
        // Setting it's name to the same one it already had
474
        prop->setValue(prop->value());
475
      }
476
    }
477
478
479
480
481
    // Try the validation again
    if (!validateProperties()) {
      notificationCenter().postNotification(
          new ErrorNotification(this, "Some invalid Properties found"));
      throw std::runtime_error("Some invalid Properties found");
482
    }
483
  }
484
  const float timingPropertyValidation = timer.elapsed(resetTimer);
485

486
487
488
489
490
491
492
493
494
  // ----- 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()
LamarMoore's avatar
LamarMoore committed
495
496
                        << "\n"
                        << ex.what() << "\n";
497
498
499
500
501
502
    notificationCenter().postNotification(
        new ErrorNotification(this, ex.what()));
    m_running = false;
    if (m_isChildAlgorithm || m_runningAsync || m_rethrow) {
      m_runningAsync = false;
      throw;
503
    }
504
505
    return false;
  }
506

507
508
  const auto executionMode = getExecutionMode();

509
  timingInit += timer.elapsed(resetTimer);
510
  // ----- Perform validation of the whole set of properties -------------
511
512
  if ((!callProcessGroups) &&
      (executionMode != Parallel::ExecutionMode::MasterOnly ||
513
514
       communicator().rank() == 0)) // for groups this is called on each
                                    // workspace separately
515
516
517
518
519
520
521
  {
    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();
522
523
524
525
      for (auto &error : errors) {
        if (this->existsProperty(error.first))
          errorLog << "Invalid value for " << error.first << ": "
                   << error.second << "\n";
526
527
528
        else {
          numErrors -= 1; // don't count it as an error
          warnLog << "validateInputs() references non-existant property \""
529
                  << error.first << "\"\n";
530
531
        }
      }
532
533
534
535
536
      // 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");
537
      }
538
    }
539
  }
540
  const float timingInputValidation = timer.elapsed(resetTimer);
541

542
543
544
545
546
547
548
549
550
551
552
553
  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);
  }
554

555
556
557
558
  // ----- Process groups -------------
  // If checkGroups() threw an exception but there ARE group workspaces
  // (means that the group sizes were incompatible)
  if (callProcessGroups) {
559
    return doCallProcessGroups(startTime);
560
  }
561

562
563
  // Read or write locks every input/output workspace
  this->lockWorkspaces();
564
  timingInit += timer.elapsed(resetTimer);
565

566
567
568
569
570
  // Invoke exec() method of derived class and catch all uncaught exceptions
  try {
    try {
      if (!isChild()) {
        m_running = true;
571
572
      }

573
      startTime = Mantid::Types::Core::DateAndTime::getCurrentTime();
574
      // Call the concrete algorithm's exec method
575
      this->exec(executionMode);
576
      registerFeatureUsage();
577
578
      // Check for a cancellation request in case the concrete algorithm doesn't
      interruption_point();
579
      const float timingExec = timer.elapsed(resetTimer);
580
581
582
      // The total runtime including all init steps is used for general logging.
      const float duration = timingInit + timingPropertyValidation +
                             timingInputValidation + timingExec;
583
584
585
      // need it to throw before trying to run fillhistory() on an algorithm
      // which has failed
      if (trackingHistory() && m_history) {
586
        m_history->fillAlgorithmHistory(this, startTime, duration,
587
588
589
                                        Algorithm::g_execCount);
        fillHistory();
        linkHistoryWithLastChild();
590
      }
591

592
593
      // Put the output workspaces into the AnalysisDataService - if requested
      if (m_alwaysStoreInADS)
594
        this->store();
595

596
      setExecuted(true);
597

598
      // Log that execution has completed.
LamarMoore's avatar
LamarMoore committed
599
600
601
602
603
604
605
606
      getLogger().debug(
          "Time to validate properties: " +
          std::to_string(timingPropertyValidation) + " seconds\n" +
          "Time for other input validation: " +
          std::to_string(timingInputValidation) + " seconds\n" +
          "Time for other initialization: " + std::to_string(timingInit) +
          " seconds\n" + "Time to run exec: " + std::to_string(timingExec) +
          " seconds\n");
607
608
609
610
      reportCompleted(duration);
    } catch (std::runtime_error &ex) {
      this->unlockWorkspaces();
      if (m_isChildAlgorithm || m_runningAsync || m_rethrow)
Nick Draper's avatar
Nick Draper committed
611
        throw;
612
      else {
LamarMoore's avatar
LamarMoore committed
613
614
615
        getLogger().error()
            << "Error in execution of algorithm " << this->name() << '\n'
            << ex.what() << '\n';
616
      }
617
618
619
620
621
622
      notificationCenter().postNotification(
          new ErrorNotification(this, ex.what()));
      m_running = false;
    } catch (std::logic_error &ex) {
      this->unlockWorkspaces();
      if (m_isChildAlgorithm || m_runningAsync || m_rethrow)
Nick Draper's avatar
Nick Draper committed
623
        throw;
624
      else {
LamarMoore's avatar
LamarMoore committed
625
626
627
        getLogger().error()
            << "Logic Error in execution of algorithm " << this->name() << '\n'
            << ex.what() << '\n';
628
      }
629
630
631
      notificationCenter().postNotification(
          new ErrorNotification(this, ex.what()));
      m_running = false;
632
    }
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
  } 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()
LamarMoore's avatar
LamarMoore committed
651
652
                        << ":\n"
                        << ex.what() << "\n";
653
654
655
    this->unlockWorkspaces();
    throw;
  }
656

657
658
659
660
661
662
663
664
665
666
667
668
669
  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;
  }
670

671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
  // Unlock the locked workspaces
  this->unlockWorkspaces();

  notificationCenter().postNotification(
      new FinishedNotification(this, isExecuted()));
  // Only gets to here if algorithm ended normally
  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;
  }
692

693
694
695
696
697
698
699
700
  if (!executed) {
    throw std::runtime_error("Unable to successfully run ChildAlgorithm " +
                             this->name());
  }
}

//---------------------------------------------------------------------------------------------
/** Stores any output workspaces into the AnalysisDataService
701
702
703
 *  @throw std::runtime_error If unable to successfully store an output
 * workspace
 */
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
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;
721
        }
722
723
      } else {
        groupWsIndicies.push_back(i);
724
      }
725
    }
726
  }
727

728
729
730
731
732
733
734
735
736
737
738
  // 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;
739
      }
740
741
742
743
744
745
    }
  }
}

//---------------------------------------------------------------------------------------------
/** Create a Child Algorithm.  A call to this method creates a child algorithm
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
 *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
 */
762
763
764
765
766
767
768
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);
769
770
771
772
773
774
775
776
777
778
779
780
781
782
  setupAsChildAlgorithm(alg, startProgress, endProgress, enableLogging);
  return alg;
}

/** Setup algorithm as child algorithm.
 *
 * Used internally by createChildAlgorithm. Arguments are as documented there.
 * Can also be used manually for algorithms created otherwise. This allows
 * running algorithms that are not declared into the factory as child
 * algorithms. */
void Algorithm::setupAsChildAlgorithm(Algorithm_sptr alg,
                                      const double startProgress,
                                      const double endProgress,
                                      const bool enableLogging) {
783
  // set as a child
Gagik Vardanyan's avatar
Gagik Vardanyan committed
784
  alg->setChild(true);
785
786
787
788
789
790
  alg->setLogging(enableLogging);

  // Initialise the Child Algorithm
  try {
    alg->initialize();
  } catch (std::runtime_error &) {
791
792
    throw std::runtime_error("Unable to initialise Child Algorithm '" +
                             alg->name() + "'");
793
  }
794

795
796
797
  // If output workspaces are nameless, give them a temporary name to satisfy
  // validator
  const std::vector<Property *> &props = alg->getProperties();
798
799
800
  for (auto prop : props) {
    auto wsProp = dynamic_cast<IWorkspaceProperty *>(prop);
    if (prop->direction() == Mantid::Kernel::Direction::Output && wsProp) {
801
      if (prop->value().empty() && !wsProp->isOptional()) {
802
        prop->createTemporaryValue();
803
      }
804
805
    }
  }
806

807
808
  if (startProgress >= 0.0 && endProgress > startProgress &&
      endProgress <= 1.0) {
809
810
811
812
    alg->addObserver(this->progressObserver());
    m_startChildProgress = startProgress;
    m_endChildProgress = endProgress;
  }
813

814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
  // 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);
  }
}

//=============================================================================================
//================================== Algorithm History
//========================================
//=============================================================================================

/**
 * Serialize this object to a string. The format is
Nick Draper's avatar
Nick Draper committed
832
 * a json formatted string.
833
834
835
 * @returns This object serialized as a string
 */
std::string Algorithm::toString() const {
836
  ::Json::FastWriter writer;
Nick Draper's avatar
Nick Draper committed
837
838
839
840
841

  return writer.write(toJson());
}

/**
842
843
844
 * Serialize this object to a json object)
 * @returns This object serialized as a json object
 */
Nick Draper's avatar
Nick Draper committed
845
846
::Json::Value Algorithm::toJson() const {
  ::Json::Value root;
847
848
849
850
851

  root["name"] = name();
  root["version"] = this->version();
  root["properties"] = Kernel::PropertyManagerOwner::asJson(false);

Nick Draper's avatar
Nick Draper committed
852
  return root;
853
854
855
856
857
858
859
860
861
862
863
}

//--------------------------------------------------------------------------------------------
/** 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) {
864
865
866
867
  ::Json::Value root;
  ::Json::Value jsonMap;
  ::Json::FastWriter writer;

868
869
870
871
872
  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()) {
873
      jsonMap[prop->name()] = prop->value();
874
    }
875
  }
876
877
878
879
880

  root["name"] = history.name();
  root["version"] = history.version();
  root["properties"] = jsonMap;

881
  const std::string output = writer.write(root);
882
883
884
  IAlgorithm_sptr alg;

  try {
885
    alg = Algorithm::fromString(output);
886
887
888
889
890
891
892
893
894
895
896
  } 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
 *
897
898
899
900
901
902
 * @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
 */
903
IAlgorithm_sptr Algorithm::fromString(const std::string &input) {
904
905
906
907
908
909
910
911
  ::Json::Value root;
  ::Json::Reader reader;

  if (reader.parse(input, root)) {
    const std::string algName = root["name"].asString();
    int version = 0;
    try {
      version = root["version"].asInt();
Nick Draper's avatar
Nick Draper committed
912
913
    } catch (std::runtime_error &) {
      // do nothing - the next test will catch it
914
    }
Nick Draper's avatar
Nick Draper committed
915
916
    if (version == 0)
      version = -1;
917

918
919
    IAlgorithm_sptr alg =
        AlgorithmManager::Instance().createUnmanaged(algName, version);
920
    alg->initialize();
921

922
923
    // get properties
    alg->setProperties(root["properties"]);
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
    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());
942
  setAlwaysStoreInADS(proxy.getAlwaysStoreInADS());
943
944
945
}

/** Fills History, Algorithm History and Algorithm Parameters
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
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());
977
          }
978
979
        }
      }
980

981
982
      // Add the history for the current algorithm to all the output workspaces
      (*outWS)->history().addHistory(m_history);
983

984
985
986
987
      // 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);
Nick Draper's avatar
Nick Draper committed
988
        }
989
      }
990
    }
991
992
993
994
995
996
997
998
  }
  // this is a child algorithm, but we still want to keep the history.
  else if (m_recordHistoryForChild && m_parentHistory) {
    m_parentHistory->addChildHistory(m_history);
  }
}

/**
999
1000
 * Link the name of the output workspaces on this parent algorithm.
 * with the last child algorithm executed to ensure they match in the history.
For faster browsing, not all history is shown. View entire blame