WorkflowAlgorithmHelpers.cpp

Go to the documentation of this file.

// 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 & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#include "MantidWorkflowAlgorithms/WorkflowAlgorithmHelpers.h"
 
#include "MantidAPI/MatrixWorkspace.h"
#include "MantidGeometry/Instrument.h"
 
using namespace Mantid::API;
using namespace Mantid::Kernel;
using namespace Mantid;
 
namespace WorkflowAlgorithmHelpers {
double getDblPropOrParam(const std::string &pmProp, Mantid::Kernel::PropertyManager_sptr &pm,
                         const std::string &instParam, Mantid::API::MatrixWorkspace_sptr &ws,
                         const double overrideValue) {
  double defaultValue = EMPTY_DBL();
  double param = defaultValue;
  if (pm->existsProperty(pmProp)) {
    param = pm->getProperty(pmProp);
    if (defaultValue == param) {
      std::vector<double> params = ws->getInstrument()->getNumberParameter(instParam);
      if (!params.empty()) {
        param = params[0];
      }
    }
  } else {
    std::vector<double> params = ws->getInstrument()->getNumberParameter(instParam);
    if (!params.empty()) {
      param = params[0];
    }
  }
  if ((defaultValue == param) && (defaultValue != overrideValue)) {
    param = overrideValue;
  }
  return param;
}
 
int getIntPropOrParam(const std::string &pmProp, Mantid::Kernel::PropertyManager_sptr &pm, const std::string &instParam,
                      Mantid::API::MatrixWorkspace_sptr &ws, const int overrideValue) {
  int defaultValue = EMPTY_INT();
  int param = defaultValue;
  if (pm->existsProperty(pmProp)) {
    param = pm->getProperty(pmProp);
    if (defaultValue == param) {
      std::vector<int> params = ws->getInstrument()->getIntParameter(instParam);
      if (!params.empty()) {
        param = params[0];
      }
    }
  } else {
    std::vector<int> params = ws->getInstrument()->getIntParameter(instParam);
    if (!params.empty()) {
      param = params[0];
    }
  }
  if ((defaultValue == param) && (defaultValue != overrideValue)) {
    param = overrideValue;
  }
  return param;
}
 
bool getBoolPropOrParam(const std::string &pmProp, Mantid::Kernel::PropertyManager_sptr &pm,
                        const std::string &instParam, Mantid::API::MatrixWorkspace_sptr &ws, const bool overrideValue) {
  bool defaultValue = false;
  bool param = defaultValue;
  if (pm->existsProperty(pmProp)) {
    param = pm->getProperty(pmProp);
  } else {
    try {
      std::vector<bool> params = ws->getInstrument()->getBoolParameter(instParam);
      if (!params.empty())
        param = params[0];
      else
        param = false;
    } catch (std::runtime_error &) // Old style bool parameter expressed as double
    {
      std::vector<double> params = ws->getInstrument()->getNumberParameter(instParam);
      if (!params.empty()) {
        param = (params[0] != 0.0);
      }
    }
  }
  if ((defaultValue == param) && (defaultValue != overrideValue)) {
    param = overrideValue;
  }
  return param;
}
} // namespace WorkflowAlgorithmHelpers