Mantid
Loading...
Searching...
No Matches
CatalogSearch.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
12#include "MantidICat/DllConfig.h"
13
14namespace Mantid {
15namespace ICat {
16
42class MANTID_ICAT_DLL CatalogSearch final : public API::Algorithm {
43public:
47 ~CatalogSearch() override = default;
49 const std::string name() const override { return "CatalogSearch"; }
51 const std::string summary() const override {
52 return "Searches all active catalogs using the provided input parameters.";
53 }
55 int version() const override { return 1; }
56 const std::vector<std::string> seeAlso() const override {
57 return {"CatalogMyDataSearch", "CatalogGetDataFiles", "CatalogLogin", "CatalogPublish"};
58 }
60 const std::string category() const override { return "DataHandling\\Catalog"; }
61
62private:
64 void init() override;
66 void exec() override;
68 void getInputProperties(CatalogSearchParam &params);
71 void setRunRanges(std::string &runRange, CatalogSearchParam &params);
72};
73} // namespace ICat
74} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
This class is used in Catalog Search service to set/get all the inputs to search for.
This class is responsible for searching the catalog using the properties specified.
Definition: CatalogSearch.h:42
int version() const override
Algorithm's version for identification overriding a virtual method.
Definition: CatalogSearch.h:55
const std::string summary() const override
Summary of algorithms purpose.
Definition: CatalogSearch.h:51
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: CatalogSearch.h:56
~CatalogSearch() override=default
destructor
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
Definition: CatalogSearch.h:49
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
Definition: CatalogSearch.h:60
Helper class which provides the Collimation Length for SANS instruments.