forked from AmbaPant/mantid
-
Notifications
You must be signed in to change notification settings - Fork 1
/
CatalogPublish.h
71 lines (65 loc) · 2.76 KB
/
CatalogPublish.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
59
60
61
62
63
64
65
66
67
68
69
70
71
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2013 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/ICatalogInfoService.h"
#include "MantidICat/CatalogAlgorithmHelper.h"
#include "MantidICat/DllConfig.h"
namespace Mantid {
namespace ICat {
/**
CatalogPublish is responsible for publishing user data to the data archive.
Required Properties:
<UL>
<LI> InvestigationNumber - The number/id of the investigation in the archives
to publish the data to.</LI>
<LI> FileName - The path to the datafile to publish to the archives.</LI>
<LI> InputWorkspace - The name of the workspace to publish to the
archives.</LI>
</UL>
@author Jay Rainey, ISIS Rutherford Appleton Laboratory
@date 06/12/2013
*/
class MANTID_ICAT_DLL CatalogPublish : public API::Algorithm {
public:
/// constructor
CatalogPublish() : API::Algorithm() {}
/// Destructor
~CatalogPublish() override {}
/// Algorithm's name for identification.
const std::string name() const override { return "CatalogPublish"; }
/// Summary of algorithms purpose.
const std::string summary() const override {
return "Allows the user to publish datafiles or workspaces to the "
"information catalog.";
}
/// Algorithm's version for identification.
int version() const override { return 1; }
const std::vector<std::string> seeAlso() const override { return {"CatalogLogin"}; }
/// Algorithm's category for identification.
const std::string category() const override { return "DataHandling\\Catalog"; }
private:
/// Override algorithm initialisation method.
void init() override;
/// Override algorithm execute method.
void exec() override;
/// Stream the contents of a file to a given URL.
void publish(std::istream &fileContents, const std::string &uploadURL);
/// We want "SaveNexus" to take care of checking groups. Not this algorithm.
bool checkGroups() override { return false; }
/// True if the extension of the file is a datafile.
bool isDataFile(const std::string &filePath);
/// Saves the workspace as a nexus file to the user's default directory.
void saveWorkspaceToNexus(Mantid::API::Workspace_sptr &workspace);
/// Publish the history of a given workspace.
void publishWorkspaceHistory(Mantid::API::ICatalogInfoService_sptr &catalogInfoService,
Mantid::API::Workspace_sptr &workspace);
/// Generate the history of a given workspace.
const std::string generateWorkspaceHistory(Mantid::API::Workspace_sptr &workspace);
};
} // namespace ICat
} // namespace Mantid