Mantid
Loading...
Searching...
No Matches
CatalogKeepAlive.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2013 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 CatalogKeepAlive final : public API::Algorithm {
29public:
33 const std::string name() const override { return "CatalogKeepAlive"; }
35 const std::string summary() const override {
36 return "Refreshes the current session to the maximum amount provided by "
37 "the catalog API.";
38 }
40 int version() const override { return 1; }
41 const std::vector<std::string> seeAlso() const override { return {"CatalogLogin"}; }
43 const std::string category() const override { return "DataHandling\\Catalog"; }
44
45private:
47 void init() override;
49 void exec() override;
50};
51} // namespace ICat
52} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
CatalogKeepAlive is responsible for keeping a catalog alive based on the session information.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
const std::string category() const override
Algorithm's category for identification.
const std::string name() const override
Algorithm's name for identification.
const std::string summary() const override
Summary of algorithms purpose.
int version() const override
Algorithm's version for identification.
Helper class which provides the Collimation Length for SANS instruments.