Mantid
Loading...
Searching...
No Matches
AddNote.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
11#include "MantidAPI/Run.h"
12#include "MantidAlgorithms/DllConfig.h"
13
14namespace Mantid {
15namespace Algorithms {
16
23class MANTID_ALGORITHMS_DLL AddNote final : public API::Algorithm, public API::DeprecatedAlgorithm {
24public:
25 AddNote();
26
27 const std::string name() const override;
28 int version() const override;
29 const std::vector<std::string> seeAlso() const override { return {"Comment"}; }
30 const std::string category() const override;
31 const std::string summary() const override;
32
33private:
34 void init() override;
35 void exec() override;
36
38 void removeExisting(API::MatrixWorkspace_sptr &, const std::string &);
40 void createOrUpdate(API::Run &, const std::string &);
41};
42
43} // namespace Algorithms
44} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Class for marking algorithms as deprecated.
This class stores information regarding an experimental run as a series of log entries.
Definition: Run.h:38
An Algorithm that adds a timestamped note to a workspace.
Definition: AddNote.h:23
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
Definition: AddNote.h:29
std::shared_ptr< MatrixWorkspace > MatrixWorkspace_sptr
shared pointer to the matrix workspace base class
Helper class which provides the Collimation Length for SANS instruments.