Mantid
Loading...
Searching...
No Matches
CatalogLogout.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2010 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 "MantidICat/DllConfig.h"
11
12namespace Mantid {
13namespace ICat {
14
24class MANTID_ICAT_DLL CatalogLogout final : public API::Algorithm {
25public:
29 ~CatalogLogout() override = default;
31 const std::string name() const override { return "CatalogLogout"; }
33 const std::string summary() const override {
34 return "Logs out all catalogs, or a specific catalog using the session "
35 "information provided.";
36 }
38 int version() const override { return 1; }
39 const std::vector<std::string> seeAlso() const override { return {"CatalogLogin"}; }
41 const std::string category() const override { return "DataHandling\\Catalog"; }
42
43private:
44 void init() override;
45 void exec() override;
46};
47} // namespace ICat
48} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
CatalogLogout is responsible for logging out of a catalog based on session information provided by th...
Definition: CatalogLogout.h:24
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
Definition: CatalogLogout.h:41
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
Definition: CatalogLogout.h:31
const std::string summary() const override
Summary of algorithms purpose.
Definition: CatalogLogout.h:33
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
Definition: CatalogLogout.h:39
int version() const override
Algorithm's version for identification overriding a virtual method.
Definition: CatalogLogout.h:38
~CatalogLogout() override=default
Destructor.
Helper class which provides the Collimation Length for SANS instruments.