-
Notifications
You must be signed in to change notification settings - Fork 122
/
UploadRemoteFile.h
81 lines (64 loc) · 2.75 KB
/
UploadRemoteFile.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
72
73
74
75
76
77
78
79
80
81
#ifndef UPLOADREMOTEFILE_H_
#define UPLOADREMOTEFILE_H_
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/DeprecatedAlgorithm.h"
namespace Mantid {
namespace RemoteAlgorithms {
/*** Upload a file to a remote compute resource
Destination directory depends on the specified transaction ID. See
StartRemoteTransaction.
Note that there are no workspaces associated with this algorithm.
Input Properties:
<UL>
<LI> ComputeResource - The name of the compute resource the file will be
sent to </LI>
<LI> TransactionID - ID of the transaction this file belongs to. See
StartRemoteTransaction </LI>
<LI> LocalFileName - The name of the file to be uploaded. This should be
the full pathnam
on the local filesystem. </LI>
<LI> RemoteFileName - The name to save the file as on the remote compute
resource. This is only
name; the actual path is determined by the compute resource. </LI>
</UL>
@author Ross Miller, ORNL
@date 04/30/2013
Copyright © 2013 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
National Laboratory & European Spallation Source
This file is part of Mantid.
Mantid is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
Mantid is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
File change history is stored at: <https://github.com/mantidproject/mantid>
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class DLLExport UploadRemoteFile : public API::Algorithm,
public API::DeprecatedAlgorithm {
public:
/// Constructor
UploadRemoteFile() { this->useAlgorithm("UploadRemoteFile", 2); }
/// Algorithm's name
const std::string name() const override { return "UploadRemoteFile"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Uploads a file to the specified compute resource.";
}
/// Algorithm's version
int version() const override { return (1); }
/// Algorithm's category for identification
const std::string category() const override { return "Remote"; }
private:
void init() override;
/// Execution code
void exec() override;
};
} // end namespace RemoteAlgorithms
} // end namespace Mantid
#endif /*UPLOADREMOTEFILE_H_*/