PeakShape.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 "MantidGeometry/DllConfig.h"
#include "MantidKernel/SpecialCoordinateSystem.h"
#include <boost/optional.hpp>
#include <memory>
#include <string>
 
namespace Mantid {
namespace Geometry {
 
class MANTID_GEOMETRY_DLL PeakShape {
public:
  virtual Mantid::Kernel::SpecialCoordinateSystem frame() const = 0;
  virtual std::string toJSON() const = 0;
  virtual PeakShape *clone() const = 0;
  virtual std::string algorithmName() const = 0;
  virtual int algorithmVersion() const = 0;
  virtual std::string shapeName() const = 0;
  enum RadiusType { Radius = 0, OuterRadius = 1, InnerRadius = 2 };
  virtual boost::optional<double> radius(RadiusType type) const = 0;
  virtual ~PeakShape() = default;
};
 
using PeakShape_sptr = std::shared_ptr<PeakShape>;
using PeakShape_const_sptr = std::shared_ptr<const PeakShape>;
 
} // namespace Geometry
} // namespace Mantid