Mantid
Loading...
Searching...
No Matches
CatalogLogin.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 {
28class MANTID_ICAT_DLL CatalogLogin final : public API::Algorithm {
29public:
33 ~CatalogLogin() override = default;
35 const std::string name() const override { return "CatalogLogin"; }
37 const std::string summary() const override { return "Authenticates credentials against a given catalog."; }
39 int version() const override { return 1; }
40 const std::vector<std::string> seeAlso() const override {
41 return {"CatalogLogout", "CatalogSearch", "CatalogPublish"};
42 }
44 const std::string category() const override { return "DataHandling\\Catalog"; }
45
46private:
48 void init() override;
50 void exec() override;
51};
52} // namespace ICat
53} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
This class is responsible for authentication of credentials against the catalog.
Definition: CatalogLogin.h:28
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: CatalogLogin.h:40
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
Definition: CatalogLogin.h:35
~CatalogLogin() override=default
Destructor.
const std::string summary() const override
Summary of algorithms purpose.
Definition: CatalogLogin.h:37
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
Definition: CatalogLogin.h:44
int version() const override
Algorithm's version for identification overriding a virtual method.
Definition: CatalogLogin.h:39
Helper class which provides the Collimation Length for SANS instruments.