Mantid
Loading...
Searching...
No Matches
CheckWorkspacesMatch.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2009 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//----------------------------------------------------------------------
10// Includes
11//----------------------------------------------------------------------
12#include "MantidAPI/Algorithm.h"
15#include "MantidAlgorithms/DllConfig.h"
17
18namespace Mantid {
19namespace Algorithms {
60class MANTID_ALGORITHMS_DLL CheckWorkspacesMatch final : public API::Algorithm, public API::DeprecatedAlgorithm {
61public:
63
65 const std::string name() const override { return "CheckWorkspacesMatch"; }
66
68 const std::string summary() const override {
69 return "Compares two workspaces for equality. This algorithm is mainly "
70 "intended for use by the Mantid development team as part of the "
71 "testing process.";
72 }
73
75 int version() const override { return (1); }
76 const std::vector<std::string> seeAlso() const override { return {"CompareWorkspaces"}; }
77
79 const std::string category() const override { return "Utility\\Workspaces"; }
80
82 static std::string successString() { return "Success!"; }
83
84private:
86 void init() override;
87
89 void exec() override;
90
92 bool processGroups() override;
93
95 std::string runCompareWorkspaces(bool group_compare = false);
96};
97
98} // namespace Algorithms
99} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Class for marking algorithms as deprecated.
Compares two workspaces for equality.
const std::string name() const override
Algorithm's name.
const std::string summary() const override
Summary of algorithms purpose.
const std::string category() const override
Algorithm's category for identification.
static std::string successString()
The string that is returned when comparison is successful.
int version() const override
Algorithm's version.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
Helper class which provides the Collimation Length for SANS instruments.