IPawleyFunction.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2015 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
 
#include "MantidAPI/DllConfig.h"
#include "MantidAPI/FunctionParameterDecorator.h"
#include "MantidAPI/IPeakFunction.h"
 
namespace Mantid {
namespace API {
 
class MANTID_API_DLL IPawleyFunction : public FunctionParameterDecorator {
public:
  IPawleyFunction();
 
  virtual void setLatticeSystem(const std::string &crystalSystem) = 0;
 
  virtual void setProfileFunction(const std::string &profileFunction) = 0;
 
  virtual void setUnitCell(const std::string &unitCellString) = 0;
 
  virtual void setPeaks(const std::vector<Kernel::V3D> &hkls, double fwhm, double height) = 0;
 
  virtual void clearPeaks() = 0;
 
  virtual void addPeak(const Kernel::V3D &hkl, double fwhm, double height) = 0;
 
  virtual size_t getPeakCount() const = 0;
 
  virtual IPeakFunction_sptr getPeakFunction(size_t i) const = 0;
 
  virtual Kernel::V3D getPeakHKL(size_t i) const = 0;
};
 
using IPawleyFunction_sptr = std::shared_ptr<IPawleyFunction>;
 
} // namespace API
} // namespace Mantid