IDomainCreator.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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 +
#pragma once
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/DomainCreatorFactory.h"
#include "MantidAPI/IFunction.h"
#include "MantidKernel/IPropertyManager.h"
 
namespace Mantid {
 
namespace API {
class FunctionDomain;
class FunctionValues;
class Workspace;
} // namespace API
 
namespace API {
class MANTID_API_DLL IDomainCreator {
public:
  enum DomainType { Simple = 0, Sequential, Parallel };
  IDomainCreator(Kernel::IPropertyManager *manager, std::vector<std::string> workspacePropertyNames,
                 DomainType domainType = Simple);
  virtual ~IDomainCreator() = default;
  virtual void initialize(Kernel::IPropertyManager *, const std::string &, DomainType) {}
 
  void separateCompositeMembersInOutput(const bool value, const bool conv = false);
 
  virtual void declareDatasetProperties(const std::string &suffix = "", bool addProp = true) {
    UNUSED_ARG(suffix);
    UNUSED_ARG(addProp);
  }
 
  virtual void createDomain(std::shared_ptr<API::FunctionDomain> &domain, std::shared_ptr<API::FunctionValues> &values,
                            size_t i0 = 0) = 0;
 
  virtual std::shared_ptr<API::Workspace>
  createOutputWorkspace(const std::string &baseName, API::IFunction_sptr function,
                        std::shared_ptr<API::FunctionDomain> domain, std::shared_ptr<API::FunctionValues> values,
                        const std::string &outputWorkspacePropertyName = "OutputWorkspace") {
    UNUSED_ARG(baseName);
    UNUSED_ARG(function);
    UNUSED_ARG(domain);
    UNUSED_ARG(values);
    UNUSED_ARG(outputWorkspacePropertyName);
    throw std::logic_error("Method createOutputWorkspace() isn't implemented");
  }
  virtual void initFunction(API::IFunction_sptr function);
 
  virtual size_t getDomainSize() const = 0;
 
  void ignoreInvalidData(bool yes) { m_ignoreInvalidData = yes; }
 
protected:
  void declareProperty(Kernel::Property *prop, const std::string &doc);
  Kernel::IPropertyManager *m_manager;
  std::vector<std::string> m_workspacePropertyNames;
  DomainType m_domainType;
  bool m_outputCompositeMembers;
  bool m_convolutionCompositeMembers;
  bool m_ignoreInvalidData;
};
 
using IDomainCreator_sptr = std::shared_ptr<IDomainCreator>;
 
} // namespace API
} // namespace Mantid
 
/* Used to register classes into the factory. creates a global object in an
 * anonymous namespace. The object itself does nothing, but the comma operator
 * is used in the call to its constructor to effect a call to the factory's
 * subscribe method.
 * The id is the key that should be used to create the object
 */
#define DECLARE_DOMAINCREATOR(classname)                                                                               \
  namespace {                                                                                                          \
  Mantid::Kernel::RegistrationHelper                                                                                   \
      register_alg_##classname(((Mantid::API::DomainCreatorFactory::Instance().subscribe<classname>(#classname)), 0)); \
  }