BraggScatterer.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2014 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 "MantidGeometry/DllConfig.h"
#include "MantidKernel/V3D.h"
 
#include <complex>
#include <memory>
 
#include "MantidKernel/PropertyManager.h"
#include "MantidKernel/TypedValidator.h"
 
namespace Mantid {
namespace Geometry {
 
using StructureFactor = std::complex<double>;
 
class BraggScatterer;
 
using BraggScatterer_sptr = std::shared_ptr<BraggScatterer>;
 
class MANTID_GEOMETRY_DLL BraggScatterer : public Kernel::PropertyManager {
public:
  BraggScatterer();
 
  void initialize();
  bool isInitialized();
 
  virtual std::string name() const = 0;
  virtual BraggScatterer_sptr clone() const = 0;
 
  virtual StructureFactor calculateStructureFactor(const Kernel::V3D &hkl) const = 0;
  double calculateFSquared(const Kernel::V3D &hkl) const;
 
  bool isPropertyExposedToComposite(const std::string &propertyName) const;
  bool isPropertyExposedToComposite(Kernel::Property *property) const;
 
protected:
  void afterPropertySet(const std::string &) override {}
 
  virtual void declareProperties() {}
 
  void exposePropertyToComposite(const std::string &propertyName);
  void unexposePropertyFromComposite(const std::string &propertyName);
 
  const std::string &getPropagatingGroupName() const;
 
private:
  std::string m_propagatingGroupName;
  bool m_isInitialized;
};
 
} // namespace Geometry
} // namespace Mantid