Mantid
Loading...
Searching...
No Matches
GenerateIPythonNotebook.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2011 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"
11
12namespace Mantid {
13namespace Algorithms {
14
26class MANTID_ALGORITHMS_DLL GenerateIPythonNotebook final : public API::Algorithm {
27public:
29 const std::string name() const override { return "GenerateIPythonNotebook"; };
31 const std::string summary() const override {
32 return "An Algorithm to generate an IPython notebook file to record the "
33 "history of a workspace.";
34 }
35
37 int version() const override { return 1; };
38 const std::vector<std::string> seeAlso() const override { return {"RecordPythonScript", "GeneratePythonScript"}; }
40 const std::string category() const override { return "Utility\\Python"; }
41
42protected:
44 void init() override;
46 void exec() override;
47};
48
49} // namespace Algorithms
50} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
const std::string category() const override
Algorithm's category for identification.
const std::string summary() const override
Summary of algorithms purpose.
int version() const override
Algorithm's version for identification.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
const std::string name() const override
Algorithm's name for identification.
Helper class which provides the Collimation Length for SANS instruments.