Algorithm.cpp 71 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
  explicit WorkspacePropertyValueIs(const std::string &value)
57
      : m_value(value) {}
Dan Nixon's avatar
Dan Nixon committed
58
  bool operator()(IWorkspaceProperty *property) {
59
    auto *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
      m_groupsHaveSimilarNames(false), m_inputWorkspaceHistories(),
107
      m_communicator(std::make_unique<Parallel::Communicator>()) {}
108
109

/// Virtual destructor
110
Algorithm::~Algorithm() {}
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

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

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

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

170
171
172
173
174
/** 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; }

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

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

221
  auto res = tokenizer.asVector();
222

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

/**
 * @return The name of the property that the calling object will be passed to.
 */
const std::string Algorithm::workspaceMethodInputProperty() const { return ""; }

//---------------------------------------------------------------------------------------------
/** Initialization method invoked by the framework. This method is responsible
256
257
258
259
260
261
262
 *  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
 *
 */
263
264
265
266
267
268
void Algorithm::initialize() {
  // Bypass the initialization if the algorithm has already been initialized.
  if (m_isInitialized)
    return;

  g_log.setName(this->name());
269
  setLoggingOffset(0);
270
271
272
  try {
    try {
      this->init();
273
      setupSkipValidationMasterOnly();
274
275
    } catch (std::runtime_error &) {
      throw;
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
    // 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>();
}

//---------------------------------------------------------------------------------------------
309
310
/**
 * Go through the properties and cache the input/output
311
312
313
314
315
316
 * workspace properties for later use.
 */
void Algorithm::cacheWorkspaceProperties() {
  m_inputWorkspaceProps.clear();
  m_outputWorkspaceProps.clear();
  m_pureOutputWorkspaceProps.clear();
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
  const auto &props = this->getProperties();
  for (const auto &prop : props) {
    auto wsProp = dynamic_cast<IWorkspaceProperty *>(prop);
    if (!wsProp)
      continue;
    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());
    }
  }
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
/**
 * Cache the histories of any input workspaces so they can be copied over after
 * algorithm completion.
 */
void Algorithm::cacheInputWorkspaceHistories() {
  if (!trackingHistory())
    return;

  auto cacheHistories = [this](const Workspace_sptr &ws) {
    if (auto group = dynamic_cast<const WorkspaceGroup *>(ws.get())) {
      m_inputWorkspaceHistories.reserve(m_inputWorkspaceHistories.size() +
                                        group->size());
      for (const auto &memberWS : *group) {
        m_inputWorkspaceHistories.emplace_back(memberWS);
      }
    } else {
      m_inputWorkspaceHistories.emplace_back(ws);
    }
  };
  using ArrayPropertyString = ArrayProperty<std::string>;
  auto isADSValidator = [](const IValidator_sptr &validator) -> bool {
    if (!validator)
      return false;
    if (dynamic_cast<ADSValidator *>(validator.get()))
      return true;
    if (const auto compValidator =
            dynamic_cast<CompositeValidator *>(validator.get()))
      return compValidator->contains<ADSValidator>();

    return false;
  };

  // Look over all properties so we can catch an string array properties
  // with an ADSValidator. ADSValidator indicates that the strings
  // point to workspace names so we want to pick up the history from these too.
  const auto &ads = AnalysisDataService::Instance();
  m_inputWorkspaceHistories.clear();
  const auto &props = this->getProperties();
  for (const auto &prop : props) {
    if (prop->direction() != Direction::Input &&
        prop->direction() != Direction::InOut)
      continue;

    if (auto wsProp = dynamic_cast<IWorkspaceProperty *>(prop)) {
      if (auto ws = wsProp->getWorkspace()) {
        cacheHistories(ws);
      } else {
        Workspace_sptr wsFromADS;
        try {
          wsFromADS = ads.retrieve(prop->value());
        } catch (Exception::NotFoundError &) {
          continue;
        }
        cacheHistories(wsFromADS);
      }
    } else if (auto strArrayProp = dynamic_cast<ArrayPropertyString *>(prop)) {
      if (!isADSValidator(strArrayProp->getValidator()))
        continue;
      const auto &wsNames((*strArrayProp)());
      for (const auto &name : wsNames) {
        cacheHistories(ads.retrieve(name));
      }
    }
  }
} // namespace API
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423

//---------------------------------------------------------------------------------------------
/** 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
424
425
  for (auto &outputWorkspaceProp : m_outputWorkspaceProps) {
    Workspace_sptr ws = outputWorkspaceProp->getWorkspace();
426
427
428
    if (ws) {
      // The workspace property says to do locking,
      // AND it has NOT already been write-locked
Hahn, Steven's avatar
Hahn, Steven committed
429
      if (outputWorkspaceProp->isLocking() &&
430
431
432
433
          std::find(m_writeLockedWorkspaces.begin(),
                    m_writeLockedWorkspaces.end(),
                    ws) == m_writeLockedWorkspaces.end()) {
        // Write-lock it if not already
434
        debugLog << "Write-locking " << ws->getName() << '\n';
435
436
        ws->getLock()->writeLock();
        m_writeLockedWorkspaces.push_back(ws);
437
438
      }
    }
439
  }
440

441
  // Next read-lock the input workspaces
Hahn, Steven's avatar
Hahn, Steven committed
442
443
  for (auto &inputWorkspaceProp : m_inputWorkspaceProps) {
    Workspace_sptr ws = inputWorkspaceProp->getWorkspace();
444
445
446
    if (ws) {
      // The workspace property says to do locking,
      // AND it has NOT already been write-locked
Hahn, Steven's avatar
Hahn, Steven committed
447
      if (inputWorkspaceProp->isLocking() &&
448
449
450
451
          std::find(m_writeLockedWorkspaces.begin(),
                    m_writeLockedWorkspaces.end(),
                    ws) == m_writeLockedWorkspaces.end()) {
        // Read-lock it if not already write-locked
452
        debugLog << "Read-locking " << ws->getName() << '\n';
453
454
455
        ws->getLock()->readLock();
        m_readLockedWorkspaces.push_back(ws);
      }
456
    }
457
458
459
460
461
462
463
464
465
466
467
468
  }
}

//---------------------------------------------------------------------------------------------
/** Unlock any previously locked workspaces
 *
 */
void Algorithm::unlockWorkspaces() {
  // Do not lock workspace for child algos
  if (this->isChild())
    return;
  auto &debugLog = g_log.debug();
469
  for (auto &ws : m_writeLockedWorkspaces) {
470
    if (ws) {
471
      debugLog << "Unlocking " << ws->getName() << '\n';
472
      ws->getLock()->unlock();
473
    }
474
  }
475
  for (auto &ws : m_readLockedWorkspaces) {
476
    if (ws) {
477
      debugLog << "Unlocking " << ws->getName() << '\n';
478
      ws->getLock()->unlock();
479
    }
480
  }
481

482
483
484
485
486
487
  // Don't double-unlock workspaces
  m_readLockedWorkspaces.clear();
  m_writeLockedWorkspaces.clear();
}

//---------------------------------------------------------------------------------------------
488
/** Invoced internally in execute()
489
 */
490
491

bool Algorithm::executeInternal() {
492
  Timer timer;
493
494
  AlgorithmManager::Instance().notifyAlgorithmStarting(this->getAlgorithmID());
  {
495
    auto *depo = dynamic_cast<DeprecatedAlgorithm *>(this);
496
    if (depo != nullptr)
497
498
      getLogger().error(depo->deprecationMsg(this));
  }
499

500
  notificationCenter().postNotification(new StartedNotification(this));
501
  Mantid::Types::Core::DateAndTime startTime;
Nick Draper's avatar
Nick Draper committed
502

503
504
505
506
507
508
509
510
511
512
  // Return a failure if the algorithm hasn't been initialized
  if (!isInitialized()) {
    throw std::runtime_error("Algorithm is not initialised:" + this->name());
  }

  // no logging of input if a child algorithm (except for python child algos)
  if (!m_isChildAlgorithm || m_alwaysStoreInADS)
    logAlgorithmInfo();

  // Check all properties for validity
513
514
  constexpr bool resetTimer{true};
  float timingInit = timer.elapsed(resetTimer);
515
516
  if (!validateProperties()) {
    // Reset name on input workspaces to trigger attempt at collection from ADS
517
    const auto &props = getProperties();
Hahn, Steven's avatar
Hahn, Steven committed
518
    for (auto &prop : props) {
519
      auto wsProp = dynamic_cast<IWorkspaceProperty *>(prop);
520
521
      if (wsProp && !(wsProp->getWorkspace())) {
        // Setting it's name to the same one it already had
522
        prop->setValue(prop->value());
523
      }
524
    }
525
526
527
528
529
    // Try the validation again
    if (!validateProperties()) {
      notificationCenter().postNotification(
          new ErrorNotification(this, "Some invalid Properties found"));
      throw std::runtime_error("Some invalid Properties found");
530
    }
531
  }
532
  const float timingPropertyValidation = timer.elapsed(resetTimer);
533

534
535
536
537
  // All properties are now valid - cache workspace properties and histories
  cacheWorkspaceProperties();
  cacheInputWorkspaceHistories();

538
539
540
541
542
543
544
545
546
  // ----- 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
547
548
                        << "\n"
                        << ex.what() << "\n";
549
550
551
552
553
554
    notificationCenter().postNotification(
        new ErrorNotification(this, ex.what()));
    m_running = false;
    if (m_isChildAlgorithm || m_runningAsync || m_rethrow) {
      m_runningAsync = false;
      throw;
555
    }
556
557
    return false;
  }
558

559
560
  const auto executionMode = getExecutionMode();

561
  timingInit += timer.elapsed(resetTimer);
562
  // ----- Perform validation of the whole set of properties -------------
563
564
  if ((!callProcessGroups) &&
      (executionMode != Parallel::ExecutionMode::MasterOnly ||
565
566
       communicator().rank() == 0)) // for groups this is called on each
                                    // workspace separately
567
568
569
570
571
572
573
  {
    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();
574
575
576
577
      for (auto &error : errors) {
        if (this->existsProperty(error.first))
          errorLog << "Invalid value for " << error.first << ": "
                   << error.second << "\n";
578
579
580
        else {
          numErrors -= 1; // don't count it as an error
          warnLog << "validateInputs() references non-existant property \""
581
                  << error.first << "\"\n";
582
583
        }
      }
584
585
586
587
588
      // 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");
589
      }
590
    }
591
  }
592
  const float timingInputValidation = timer.elapsed(resetTimer);
593

594
595
596
597
598
599
600
601
602
603
604
605
  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);
  }
606

607
608
609
610
  // ----- Process groups -------------
  // If checkGroups() threw an exception but there ARE group workspaces
  // (means that the group sizes were incompatible)
  if (callProcessGroups) {
611
    return doCallProcessGroups(startTime);
612
  }
613

614
615
  // Read or write locks every input/output workspace
  this->lockWorkspaces();
616
  timingInit += timer.elapsed(resetTimer);
617

618
619
620
  // Invoke exec() method of derived class and catch all uncaught exceptions
  try {
    try {
621
      setExecuted(false);
622
623
      if (!isChild()) {
        m_running = true;
624
625
      }

626
      startTime = Mantid::Types::Core::DateAndTime::getCurrentTime();
627
      // Call the concrete algorithm's exec method
628
      this->exec(executionMode);
629
      registerFeatureUsage();
630
631
      // Check for a cancellation request in case the concrete algorithm doesn't
      interruption_point();
632
      const float timingExec = timer.elapsed(resetTimer);
633
634
635
      // The total runtime including all init steps is used for general logging.
      const float duration = timingInit + timingPropertyValidation +
                             timingInputValidation + timingExec;
636
637
638
      // need it to throw before trying to run fillhistory() on an algorithm
      // which has failed
      if (trackingHistory() && m_history) {
639
        m_history->fillAlgorithmHistory(this, startTime, duration,
640
641
642
                                        Algorithm::g_execCount);
        fillHistory();
        linkHistoryWithLastChild();
643
      }
644

645
646
      // Put the output workspaces into the AnalysisDataService - if requested
      if (m_alwaysStoreInADS)
647
        this->store();
648

649
      setExecuted(true);
650

651
      // Log that execution has completed.
LamarMoore's avatar
LamarMoore committed
652
653
654
655
656
657
658
659
      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");
660
661
662
663
      reportCompleted(duration);
    } catch (std::runtime_error &ex) {
      this->unlockWorkspaces();
      if (m_isChildAlgorithm || m_runningAsync || m_rethrow)
Nick Draper's avatar
Nick Draper committed
664
        throw;
665
      else {
LamarMoore's avatar
LamarMoore committed
666
667
668
        getLogger().error()
            << "Error in execution of algorithm " << this->name() << '\n'
            << ex.what() << '\n';
669
      }
670
671
672
673
674
675
      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
676
        throw;
677
      else {
LamarMoore's avatar
LamarMoore committed
678
679
680
        getLogger().error()
            << "Logic Error in execution of algorithm " << this->name() << '\n'
            << ex.what() << '\n';
681
      }
682
683
684
      notificationCenter().postNotification(
          new ErrorNotification(this, ex.what()));
      m_running = false;
685
    }
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
  } 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
704
705
                        << ":\n"
                        << ex.what() << "\n";
706
707
708
    this->unlockWorkspaces();
    throw;
  }
709

710
711
712
713
714
715
716
717
718
719
720
721
722
  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;
  }
723

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

746
747
748
749
750
751
752
753
  if (!executed) {
    throw std::runtime_error("Unable to successfully run ChildAlgorithm " +
                             this->name());
  }
}

//---------------------------------------------------------------------------------------------
/** Stores any output workspaces into the AnalysisDataService
754
755
756
 *  @throw std::runtime_error If unable to successfully store an output
 * workspace
 */
757
758
759
760
761
762
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) {
763
    auto *wsProp = dynamic_cast<IWorkspaceProperty *>(props[i]);
764
765
766
767
768
769
770
771
772
773
    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;
774
        }
775
776
      } else {
        groupWsIndicies.push_back(i);
777
      }
778
    }
779
  }
780

781
782
783
784
  // now store workspace groups once their members have been added
  std::vector<int>::const_iterator wsIndex;
  for (wsIndex = groupWsIndicies.begin(); wsIndex != groupWsIndicies.end();
       ++wsIndex) {
785
    auto *wsProp = dynamic_cast<IWorkspaceProperty *>(props[*wsIndex]);
786
787
788
789
790
    if (wsProp) {
      try {
        wsProp->store();
      } catch (std::runtime_error &) {
        throw;
791
      }
792
793
794
795
796
797
    }
  }
}

//---------------------------------------------------------------------------------------------
/** Create a Child Algorithm.  A call to this method creates a child algorithm
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
 *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
 */
814
815
816
817
818
819
820
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);
821
822
823
824
825
826
827
828
829
830
831
832
833
834
  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) {
835
  // set as a child
Gagik Vardanyan's avatar
Gagik Vardanyan committed
836
  alg->setChild(true);
837
838
839
840
841
842
  alg->setLogging(enableLogging);

  // Initialise the Child Algorithm
  try {
    alg->initialize();
  } catch (std::runtime_error &) {
843
844
    throw std::runtime_error("Unable to initialise Child Algorithm '" +
                             alg->name() + "'");
845
  }
846

847
848
849
  // If output workspaces are nameless, give them a temporary name to satisfy
  // validator
  const std::vector<Property *> &props = alg->getProperties();
850
851
852
  for (auto prop : props) {
    auto wsProp = dynamic_cast<IWorkspaceProperty *>(prop);
    if (prop->direction() == Mantid::Kernel::Direction::Output && wsProp) {
853
      if (prop->value().empty() && !wsProp->isOptional()) {
854
        prop->createTemporaryValue();
855
      }
856
857
    }
  }
858

859
860
  if (startProgress >= 0.0 && endProgress > startProgress &&
      endProgress <= 1.0) {
861
862
863
864
    alg->addObserver(this->progressObserver());
    m_startChildProgress = startProgress;
    m_endChildProgress = endProgress;
  }
865

866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
  // 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
884
 * a json formatted string.
885
886
887
 * @returns This object serialized as a string
 */
std::string Algorithm::toString() const {
888
  ::Json::FastWriter writer;
Nick Draper's avatar
Nick Draper committed
889
890
891
892
893

  return writer.write(toJson());
}

/**
894
895
896
 * Serialize this object to a json object)
 * @returns This object serialized as a json object
 */
Nick Draper's avatar
Nick Draper committed
897
898
::Json::Value Algorithm::toJson() const {
  ::Json::Value root;
899
900
901
902
903

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

Nick Draper's avatar
Nick Draper committed
904
  return root;
905
906
907
908
909
910
911
912
913
914
915
}

//--------------------------------------------------------------------------------------------
/** 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) {
916
917
918
919
  ::Json::Value root;
  ::Json::Value jsonMap;
  ::Json::FastWriter writer;

920
921
922
923
924
  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()) {
925
      jsonMap[prop->name()] = prop->value();
926
    }
927
  }
928
929
930
931
932

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

933
  const std::string output = writer.write(root);
934
935
936
  IAlgorithm_sptr alg;

  try {
937
    alg = Algorithm::fromString(output);
938
939
940
941
942
943
944
945
946
947
948
  } 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
 *
949
 * @param input :: An input string in the format. The format is
950
951
 * AlgorithmName.version(prop1=value1,prop2=value2,...). If .version is
 * not found the highest found is used.
952
 * @return A pointer to a managed algorithm object
953
 * @throws std::runtime_error if the algorithm cannot be created
954
 */
955
IAlgorithm_sptr Algorithm::fromString(const std::string &input) {
956
957
958
  ::Json::Value root;
  ::Json::Reader reader;
  if (reader.parse(input, root)) {
959
    return fromJson(root);
960
961
962
963
964
  } else {
    throw std::runtime_error("Cannot create algorithm, invalid string format.");
  }
}

965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
/**
 * De-serializes the algorithm from a Json object
 * @param serialized A reference to Json::Value that contains a serialized
 * algorithm object
 * @return A new algorithm object
 * @throws std::runtime_error if the algorithm cannot be created
 */
IAlgorithm_sptr Algorithm::fromJson(const Json::Value &serialized) {
  const std::string algName = serialized["name"].asString();
  const int version = serialized.get("version", -1).asInt();
  auto alg = AlgorithmManager::Instance().createUnmanaged(algName, version);
  alg->initialize();
  alg->setProperties(serialized["properties"]);
  return alg;
}

981
982
983
984
985
986
987
988
989
990
991
992
//-------------------------------------------------------------------------
/** 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());
993
  setAlwaysStoreInADS(proxy.getAlwaysStoreInADS());
994
995
996
}

/** Fills History, Algorithm History and Algorithm Parameters
997
 */
998
void Algorithm::fillHistory() {
999
  WorkspaceVector outputWorkspaces;
1000
  if (!isChild()) {