Mantid
Loading...
Searching...
No Matches
CatalogListInstruments.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
11#include "MantidICat/DllConfig.h"
12
13namespace Mantid {
14namespace ICat {
21class MANTID_ICAT_DLL CatalogListInstruments final : public API::Algorithm {
22public:
26 ~CatalogListInstruments() override = default;
28 const std::string name() const override { return "CatalogListInstruments"; }
30 const std::string summary() const override {
31 return "Lists the name of instruments from all catalogs or a specific "
32 "catalog based on session information.";
33 }
35 int version() const override { return 1; }
36 const std::vector<std::string> seeAlso() const override { return {"CatalogListInvestigationTypes"}; }
38 const std::string category() const override { return "DataHandling\\Catalog"; }
39
40private:
42 void init() override;
44 void exec() override;
45};
46} // namespace ICat
47} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
This algorithm obtains a list of instruments types from the catalog.
int version() const override
Algorithm's version for identification overriding a virtual method.
~CatalogListInstruments() override=default
destructor
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 summary() const override
Summary of algorithms purpose.
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
Helper class which provides the Collimation Length for SANS instruments.