forked from AmbaPant/mantid
-
Notifications
You must be signed in to change notification settings - Fork 1
/
CatalogGetDataFiles.h
58 lines (51 loc) · 1.97 KB
/
CatalogGetDataFiles.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 ISIS Rutherford Appleton Laboratory UKRI,
// NScD Oak Ridge National Laboratory, European Spallation Source,
// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/ITableWorkspace_fwd.h"
#include "MantidICat/DllConfig.h"
namespace Mantid {
namespace ICat {
/**
CatalogGetDataFiles obtains a list of datafiles and related information for an
investigation.
Required Properties:
<UL>
<LI> InvestigationId - The id of the investigation to use for searching.</LI>
<LI> OutputWorkspace - The workspace to store the datafile information.</LI>
</UL>
@author Sofia Antony, ISIS Rutherford Appleton Laboratory
@date 07/07/2010
*/
class MANTID_ICAT_DLL CatalogGetDataFiles final : public API::Algorithm {
public:
/// Constructor
CatalogGetDataFiles() : API::Algorithm() {}
/// Destructor
~CatalogGetDataFiles() override = default;
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "CatalogGetDataFiles"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Obtains information of the datafiles associated to a specific "
"investigation.";
}
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 1; }
const std::vector<std::string> seeAlso() const override {
return {"CatalogDownloadDataFiles", "CatalogGetDataSets", "CatalogLogin", "ISISJournalGetExperimentRuns"};
}
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override { return "DataHandling\\Catalog"; }
private:
/// Overwrites Algorithm method.
void init() override;
/// Overwrites Algorithm method
void exec() override;
};
} // namespace ICat
} // namespace Mantid