Algorithm.cpp 74.6 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
using namespace Mantid::Kernel;
47
using VectorStringProperty = PropertyWithValue<std::vector<std::string>>;
48

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

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

private:
67
  const std::string &m_value;
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

/**
 * Check if a given validator is an ADS validator
 * @param validator A reference to a validator object
 * @return True if the object is an ADSValidator or a Composite containing an
 * ADSValidator
 */
bool isADSValidator(const IValidator &validator) {
  if (dynamic_cast<const ADSValidator *>(&validator)) {
    return true;
  }
  const auto *compositeValidator =
      dynamic_cast<const CompositeValidator *>(&validator);
  if (!compositeValidator)
    return false;

  const std::list<IValidator_sptr> validatorList =
      compositeValidator->getChildren();
  for (const IValidator_sptr &childValidator : validatorList) {
    if (isADSValidator(*childValidator)) {
      return true;
    }
  }
  return false;
}

/**
 * Attempt to return a pointer to a Workspace from a Property
 * @param prop A reference to a Property object
 * @param ads A reference to the ADS
 * @param strValue The string value of the property. Used for the ADS lookup
 * if applicable
 * @param checkADS If true then check the ADS for the string value as a name
 * if look up on the property fail
 * @return A null pointer if we cannot access a workspace
 * @throws Exception::NotFoundError if the strValue cannot be found on the ADS
 */
Workspace_sptr workspaceFromWSProperty(const IWorkspaceProperty &prop,
                                       const AnalysisDataServiceImpl &ads,
                                       const std::string &strValue,
                                       bool checkADS) {
  auto workspace = prop.getWorkspace();
  if (workspace)
    return workspace;

  if (checkADS) {
    return ads.retrieve(strValue);
  }
  return Workspace_sptr();
}

/**
 * Attempt to extract a list of workspaces from the
 * @param prop A reference to the string list property
 * @param ads A reference to the ADS
 * @return A list of workspaces
 */
std::vector<Workspace_sptr>
workspacesFromStringList(const VectorStringProperty &prop,
                         const AnalysisDataServiceImpl &ads) {
  std::vector<Workspace_sptr> workspaces;
  const auto &names = prop();
  workspaces.reserve(names.size());
  for (const auto &name : names) {
    workspaces.emplace_back(ads.retrieve(name));
  }
  return workspaces;
}

138
} // namespace
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

// 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),
169
170
      m_log("Algorithm"), g_log(m_log), m_groupSize(0), m_executeAsync(nullptr),
      m_notificationCenter(nullptr), m_progressObserver(nullptr),
171
      m_isInitialized(false), m_isExecuted(false), m_isChildAlgorithm(false),
172
      m_recordHistoryForChild(false), m_alwaysStoreInADS(true),
173
      m_runningAsync(false), m_running(false), m_rethrow(false),
174
175
      m_isAlgStartupLoggingEnabled(true), m_startChildProgress(0.),
      m_endChildProgress(0.), m_algorithmID(this), m_singleGroup(-1),
176
177
      m_groupsHaveSimilarNames(false),
      m_communicator(Kernel::make_unique<Parallel::Communicator>()) {}
178
179

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

//=============================================================================================
//================================== 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.
208
209
210
 *  @returns true - the algorithm is a child algorithm.  False - this is a full
 * managed algorithm.
 */
211
212
213
bool Algorithm::isChild() const { return m_isChildAlgorithm; }

/** To set whether algorithm is a child.
214
215
216
 *  @param isChild :: True - the algorithm is a child algorithm.  False - this
 * is a full managed algorithm.
 */
217
void Algorithm::setChild(const bool isChild) {
Gagik Vardanyan's avatar
Gagik Vardanyan committed
218
219
  m_isChildAlgorithm = isChild;
  this->setAlwaysStoreInADS(!isChild);
220
}
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239

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

240
241
242
243
244
/** 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; }

245
246
247
248
249
250
/** 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.
251
bool Algorithm::isRunning() const { return m_running; }
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275

//---------------------------------------------------------------------------------------------
/**  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.
276
 */
277
278
279
280
281
282
283
284
285
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 {
286
287
288
289
  Mantid::Kernel::StringTokenizer tokenizer(
      category(), categorySeparator(),
      Mantid::Kernel::StringTokenizer::TOK_TRIM |
          Mantid::Kernel::StringTokenizer::TOK_IGNORE_EMPTY);
290

291
  auto res = tokenizer.asVector();
292

293
294
  const DeprecatedAlgorithm *depo =
      dynamic_cast<const DeprecatedAlgorithm *>(this);
295
  if (depo != nullptr) {
296
    res.emplace_back("Deprecated");
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
  }
  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 {
313
314
315
316
  Mantid::Kernel::StringTokenizer tokenizer(
      this->workspaceMethodOnTypes(), WORKSPACE_TYPES_SEPARATOR,
      Mantid::Kernel::StringTokenizer::TOK_TRIM |
          Mantid::Kernel::StringTokenizer::TOK_IGNORE_EMPTY);
317
  return tokenizer.asVector();
318
319
320
321
322
323
324
325
326
327
328
329
330
331
}

/**
 * @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
332
333
334
335
336
337
338
 *  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
 *
 */
339
340
341
342
343
344
void Algorithm::initialize() {
  // Bypass the initialization if the algorithm has already been initialized.
  if (m_isInitialized)
    return;

  g_log.setName(this->name());
345
  setLoggingOffset(0);
346
347
348
  try {
    try {
      this->init();
349
      setupSkipValidationMasterOnly();
350
351
    } catch (std::runtime_error &) {
      throw;
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
    // 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();
394
  for (auto prop : props) {
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
    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());
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
    } // 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
439
440
  for (auto &outputWorkspaceProp : m_outputWorkspaceProps) {
    Workspace_sptr ws = outputWorkspaceProp->getWorkspace();
441
442
443
    if (ws) {
      // The workspace property says to do locking,
      // AND it has NOT already been write-locked
Hahn, Steven's avatar
Hahn, Steven committed
444
      if (outputWorkspaceProp->isLocking() &&
445
446
447
448
          std::find(m_writeLockedWorkspaces.begin(),
                    m_writeLockedWorkspaces.end(),
                    ws) == m_writeLockedWorkspaces.end()) {
        // Write-lock it if not already
449
        debugLog << "Write-locking " << ws->getName() << '\n';
450
451
        ws->getLock()->writeLock();
        m_writeLockedWorkspaces.push_back(ws);
452
453
      }
    }
454
  }
455

456
  // Next read-lock the input workspaces
Hahn, Steven's avatar
Hahn, Steven committed
457
458
  for (auto &inputWorkspaceProp : m_inputWorkspaceProps) {
    Workspace_sptr ws = inputWorkspaceProp->getWorkspace();
459
460
461
    if (ws) {
      // The workspace property says to do locking,
      // AND it has NOT already been write-locked
Hahn, Steven's avatar
Hahn, Steven committed
462
      if (inputWorkspaceProp->isLocking() &&
463
464
465
466
          std::find(m_writeLockedWorkspaces.begin(),
                    m_writeLockedWorkspaces.end(),
                    ws) == m_writeLockedWorkspaces.end()) {
        // Read-lock it if not already write-locked
467
        debugLog << "Read-locking " << ws->getName() << '\n';
468
469
470
        ws->getLock()->readLock();
        m_readLockedWorkspaces.push_back(ws);
      }
471
    }
472
473
474
475
476
477
478
479
480
481
482
483
  }
}

//---------------------------------------------------------------------------------------------
/** Unlock any previously locked workspaces
 *
 */
void Algorithm::unlockWorkspaces() {
  // Do not lock workspace for child algos
  if (this->isChild())
    return;
  auto &debugLog = g_log.debug();
484
  for (auto &ws : m_writeLockedWorkspaces) {
485
    if (ws) {
486
      debugLog << "Unlocking " << ws->getName() << '\n';
487
      ws->getLock()->unlock();
488
    }
489
  }
490
  for (auto &ws : m_readLockedWorkspaces) {
491
    if (ws) {
492
      debugLog << "Unlocking " << ws->getName() << '\n';
493
      ws->getLock()->unlock();
494
    }
495
  }
496

497
498
499
500
501
502
503
  // 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
504
505
506
 *  invoked for top level algorithms by the application manager.
 *  This method invokes exec() method.
 *  For Child Algorithms either the execute() method or exec() method
507
 *  must be EXPLICITLY invoked by the parent algorithm.
508
509
510
511
512
 *
 *  @throw runtime_error Thrown if algorithm or Child Algorithm cannot be
 *executed
 *  @return true if executed successfully.
 */
513
bool Algorithm::execute() {
514
  Timer timer;
515
516
517
  AlgorithmManager::Instance().notifyAlgorithmStarting(this->getAlgorithmID());
  {
    DeprecatedAlgorithm *depo = dynamic_cast<DeprecatedAlgorithm *>(this);
518
    if (depo != nullptr)
519
520
      getLogger().error(depo->deprecationMsg(this));
  }
521

522
  notificationCenter().postNotification(new StartedNotification(this));
523
  Mantid::Types::Core::DateAndTime startTime;
Nick Draper's avatar
Nick Draper committed
524

525
526
527
528
529
530
531
532
533
534
535
536
537
  // 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
538
539
  constexpr bool resetTimer{true};
  float timingInit = timer.elapsed(resetTimer);
540
541
542
  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
543
    for (auto &prop : props) {
544
      IWorkspaceProperty *wsProp = dynamic_cast<IWorkspaceProperty *>(prop);
545
546
      if (wsProp && !(wsProp->getWorkspace())) {
        // Setting it's name to the same one it already had
547
        prop->setValue(prop->value());
548
      }
549
    }
550
551
552
553
554
    // Try the validation again
    if (!validateProperties()) {
      notificationCenter().postNotification(
          new ErrorNotification(this, "Some invalid Properties found"));
      throw std::runtime_error("Some invalid Properties found");
555
    }
556
  }
557
  const float timingPropertyValidation = timer.elapsed(resetTimer);
558

559
560
561
562
563
564
565
566
567
  // ----- 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
568
569
                        << "\n"
                        << ex.what() << "\n";
570
571
572
573
574
575
    notificationCenter().postNotification(
        new ErrorNotification(this, ex.what()));
    m_running = false;
    if (m_isChildAlgorithm || m_runningAsync || m_rethrow) {
      m_runningAsync = false;
      throw;
576
    }
577
578
    return false;
  }
579

580
581
  const auto executionMode = getExecutionMode();

582
  timingInit += timer.elapsed(resetTimer);
583
  // ----- Perform validation of the whole set of properties -------------
584
585
  if ((!callProcessGroups) &&
      (executionMode != Parallel::ExecutionMode::MasterOnly ||
586
587
       communicator().rank() == 0)) // for groups this is called on each
                                    // workspace separately
588
589
590
591
592
593
594
  {
    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();
595
596
597
598
      for (auto &error : errors) {
        if (this->existsProperty(error.first))
          errorLog << "Invalid value for " << error.first << ": "
                   << error.second << "\n";
599
600
601
        else {
          numErrors -= 1; // don't count it as an error
          warnLog << "validateInputs() references non-existant property \""
602
                  << error.first << "\"\n";
603
604
        }
      }
605
606
607
608
609
      // 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");
610
      }
611
    }
612
  }
613
  const float timingInputValidation = timer.elapsed(resetTimer);
614

615
616
617
618
619
620
621
622
623
624
625
626
  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);
  }
627

628
629
630
631
  // ----- Process groups -------------
  // If checkGroups() threw an exception but there ARE group workspaces
  // (means that the group sizes were incompatible)
  if (callProcessGroups) {
632
    return doCallProcessGroups(startTime);
633
  }
634

635
636
  // Read or write locks every input/output workspace
  this->lockWorkspaces();
637
  timingInit += timer.elapsed(resetTimer);
638

639
640
641
642
643
  // Invoke exec() method of derived class and catch all uncaught exceptions
  try {
    try {
      if (!isChild()) {
        m_running = true;
644
645
      }

646
      startTime = Mantid::Types::Core::DateAndTime::getCurrentTime();
647
      // Call the concrete algorithm's exec method
648
      this->exec(executionMode);
649
      registerFeatureUsage();
650
651
      // Check for a cancellation request in case the concrete algorithm doesn't
      interruption_point();
652
      const float timingExec = timer.elapsed(resetTimer);
653
654
655
      // The total runtime including all init steps is used for general logging.
      const float duration = timingInit + timingPropertyValidation +
                             timingInputValidation + timingExec;
656
657
658
      // need it to throw before trying to run fillhistory() on an algorithm
      // which has failed
      if (trackingHistory() && m_history) {
659
        m_history->fillAlgorithmHistory(this, startTime, duration,
660
661
662
                                        Algorithm::g_execCount);
        fillHistory();
        linkHistoryWithLastChild();
663
      }
664

665
666
      // Put the output workspaces into the AnalysisDataService - if requested
      if (m_alwaysStoreInADS)
667
        this->store();
668

669
      setExecuted(true);
670

671
      // Log that execution has completed.
LamarMoore's avatar
LamarMoore committed
672
673
674
675
676
677
678
679
      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");
680
681
682
683
      reportCompleted(duration);
    } catch (std::runtime_error &ex) {
      this->unlockWorkspaces();
      if (m_isChildAlgorithm || m_runningAsync || m_rethrow)
Nick Draper's avatar
Nick Draper committed
684
        throw;
685
      else {
LamarMoore's avatar
LamarMoore committed
686
687
688
        getLogger().error()
            << "Error in execution of algorithm " << this->name() << '\n'
            << ex.what() << '\n';
689
      }
690
691
692
693
694
695
      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
696
        throw;
697
      else {
LamarMoore's avatar
LamarMoore committed
698
699
700
        getLogger().error()
            << "Logic Error in execution of algorithm " << this->name() << '\n'
            << ex.what() << '\n';
701
      }
702
703
704
      notificationCenter().postNotification(
          new ErrorNotification(this, ex.what()));
      m_running = false;
705
    }
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
  } 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
724
725
                        << ":\n"
                        << ex.what() << "\n";
726
727
728
    this->unlockWorkspaces();
    throw;
  }
729

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

744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
  // 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;
  }
765

766
767
768
769
770
771
772
773
  if (!executed) {
    throw std::runtime_error("Unable to successfully run ChildAlgorithm " +
                             this->name());
  }
}

//---------------------------------------------------------------------------------------------
/** Stores any output workspaces into the AnalysisDataService
774
775
776
 *  @throw std::runtime_error If unable to successfully store an output
 * workspace
 */
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
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;
794
        }
795
796
      } else {
        groupWsIndicies.push_back(i);
797
      }
798
    }
799
  }
800

801
802
803
804
805
806
807
808
809
810
811
  // 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;
812
      }
813
814
815
816
817
818
    }
  }
}

//---------------------------------------------------------------------------------------------
/** Create a Child Algorithm.  A call to this method creates a child algorithm
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
 *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
 */
835
836
837
838
839
840
841
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);
842
843
844
845
846
847
848
849
850
851
852
853
854
855
  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) {
856
  // set as a child
Gagik Vardanyan's avatar
Gagik Vardanyan committed
857
  alg->setChild(true);
858
859
860
861
862
863
  alg->setLogging(enableLogging);

  // Initialise the Child Algorithm
  try {
    alg->initialize();
  } catch (std::runtime_error &) {
864
865
    throw std::runtime_error("Unable to initialise Child Algorithm '" +
                             alg->name() + "'");
866
  }
867

868
869
870
  // If output workspaces are nameless, give them a temporary name to satisfy
  // validator
  const std::vector<Property *> &props = alg->getProperties();
871
872
873
  for (auto prop : props) {
    auto wsProp = dynamic_cast<IWorkspaceProperty *>(prop);
    if (prop->direction() == Mantid::Kernel::Direction::Output && wsProp) {
874
      if (prop->value().empty() && !wsProp->isOptional()) {
875
        prop->createTemporaryValue();
876
      }
877
878
    }
  }
879

880
881
  if (startProgress >= 0.0 && endProgress > startProgress &&
      endProgress <= 1.0) {
882
883
884
885
    alg->addObserver(this->progressObserver());
    m_startChildProgress = startProgress;
    m_endChildProgress = endProgress;
  }
886

887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
  // 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
905
 * a json formatted string.
906
907
908
 * @returns This object serialized as a string
 */
std::string Algorithm::toString() const {
909
  ::Json::FastWriter writer;
Nick Draper's avatar
Nick Draper committed
910
911
912
913
914

  return writer.write(toJson());
}

/**
915
916
917
 * Serialize this object to a json object)
 * @returns This object serialized as a json object
 */
Nick Draper's avatar
Nick Draper committed
918
919
::Json::Value Algorithm::toJson() const {
  ::Json::Value root;
920
921
922
923
924

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

Nick Draper's avatar
Nick Draper committed
925
  return root;
926
927
928
929
930
931
932
933
934
935
936
}

//--------------------------------------------------------------------------------------------
/** 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) {
937
938
939
940
  ::Json::Value root;
  ::Json::Value jsonMap;
  ::Json::FastWriter writer;

941
942
943
944
945
  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()) {
946
      jsonMap[prop->name()] = prop->value();
947
    }
948
  }
949
950
951
952
953

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

954
  const std::string output = writer.write(root);
955
956
957
  IAlgorithm_sptr alg;

  try {
958
    alg = Algorithm::fromString(output);
959
960
961
962
963
964
965
966
967
968
969
  } 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
 *
970
971
972
973
974
975
 * @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
 */
976
IAlgorithm_sptr Algorithm::fromString(const std::string &input) {
977
978
979
980
981
982
983
984
  ::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
985
986
    } catch (std::runtime_error &) {
      // do nothing - the next test will catch it
987
    }
Nick Draper's avatar
Nick Draper committed
988
989
    if (version == 0)
      version = -1;
990

991
992
    IAlgorithm_sptr alg =
        AlgorithmManager::Instance().createUnmanaged(algName, version);
993
    alg->initialize();
994

995
996
    // get properties
    alg->setProperties(root["properties"]);
997
998
999
1000
    return alg;
  } else {
    throw std::runtime_error("Cannot create algorithm, invalid string format.");
  }
For faster browsing, not all history is shown. View entire blame