Mantid
Loading...
Searching...
No Matches
AddPeak.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2012 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
10#include "MantidAlgorithms/DllConfig.h"
11namespace Mantid {
12namespace Algorithms {
13
19class MANTID_ALGORITHMS_DLL AddPeak final : public API::Algorithm {
20public:
22 const std::string name() const override { return "AddPeak"; };
24 const std::string summary() const override { return "Adds a peak to a PeaksWorkspace."; }
26 int version() const override { return 1; };
27 const std::vector<std::string> seeAlso() const override { return {"AddPeakHKL", "CalculatePeaksHKL"}; }
29 const std::string category() const override { return "Crystal\\Peaks"; }
30
31private:
33 void init() override;
35 void exec() override;
36};
37
38} // namespace Algorithms
39} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Add a peak to a PeaksWorkspace.
Definition: AddPeak.h:19
int version() const override
Algorithm's version for identification.
Definition: AddPeak.h:26
const std::string summary() const override
Summary of algorithms purpose.
Definition: AddPeak.h:24
const std::string name() const override
Algorithm's name for identification.
Definition: AddPeak.h:22
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
Definition: AddPeak.h:27
const std::string category() const override
Algorithm's category for identification.
Definition: AddPeak.h:29
Helper class which provides the Collimation Length for SANS instruments.