Mantid
Loading...
Searching...
No Matches
PeakShapeBase.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2015 ISIS Rutherford Appleton Laboratory UKRI,
4// NScD Oak Ridge National Laboratory, European Spallation Source,
5// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
6// SPDX - License - Identifier: GPL - 3.0 +
7#pragma once
8
9#include "MantidDataObjects/DllConfig.h"
12
13#include <string>
14
15namespace Json {
16// Forward declaration
17class Value;
18} // namespace Json
19
20namespace Mantid {
21namespace DataObjects {
22
26class MANTID_DATAOBJECTS_DLL PeakShapeBase : public Mantid::Geometry::PeakShape {
27
28public:
30 PeakShapeBase(Kernel::SpecialCoordinateSystem frame, std::string algorithmName = std::string(),
31 int algorithmVersion = -1);
33 Kernel::SpecialCoordinateSystem frame() const override;
35 std::string algorithmName() const override;
37 int algorithmVersion() const override;
38
39protected:
41 PeakShapeBase(const PeakShapeBase &) = default;
42
45
48
50 std::string m_algorithmName;
51
54
56 void buildCommon(Json::Value &root) const;
57
59 bool operator==(const PeakShapeBase &other) const;
60};
61
62} // namespace DataObjects
63} // namespace Mantid
PeakShapeBase : Base class for concrete PeakShapes containing common code.
Definition: PeakShapeBase.h:26
Mantid::Kernel::SpecialCoordinateSystem m_frame
Special coordinate system.
Definition: PeakShapeBase.h:47
std::string m_algorithmName
Generating algorithm name.
Definition: PeakShapeBase.h:50
PeakShapeBase(const PeakShapeBase &)=default
Copy constructor.
PeakShapeBase & operator=(const PeakShapeBase &)=default
Assignment operator.
int m_algorithmVersion
Generating algorithm version.
Definition: PeakShapeBase.h:53
PeakShape : Abstract type to describes the shape of a peak.
Definition: PeakShape.h:20
Definition: Algorithm.h:38
SpecialCoordinateSystem
Special coordinate systems for Q3D.
Helper class which provides the Collimation Length for SANS instruments.
constexpr bool operator==(const wide_integer< Bits, Signed > &lhs, const wide_integer< Bits2, Signed2 > &rhs)