-
Notifications
You must be signed in to change notification settings - Fork 122
/
CatalogDownloadDataFiles.h
98 lines (85 loc) · 3.54 KB
/
CatalogDownloadDataFiles.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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
#ifndef MANTID_ICAT_CATALOGDOWNLOADDATAFILES_H_
#define MANTID_ICAT_CATALOGDOWNLOADDATAFILES_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidICat/DllConfig.h"
namespace Mantid {
namespace ICat {
/**
CatalogDownloadDataFiles is responsible for downloading datafiles from a
catalog.
Required Properties:
<UL>
<LI> Filenames - List of files to download </LI>
<LI> InputWorkspace - The name of the workspace whioch stored the last
investigation search results </LI>
<LI> FileLocations - List of files with location which is downloaded </LI>
</UL>
@author Sofia Antony, ISIS Rutherford Appleton Laboratory
@date 07/07/2010
Copyright © 2010 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 MANTID_ICAT_DLL CatalogDownloadDataFiles : public API::Algorithm {
public:
/// Constructor
CatalogDownloadDataFiles() : API::Algorithm(), m_prog(0.0) {}
/// Destructor
~CatalogDownloadDataFiles() override {}
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "CatalogDownloadDataFiles"; }
/// Summary of algorithms purpose.
const std::string summary() const override {
return "Downloads datafiles from the archives based on the ID of a "
"datafile.";
}
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 1; }
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override {
return "DataHandling\\Catalog";
}
/** This method is used for unit testing purpose.
* as the Poco::Net library httpget throws an exception when the nd server n/w
* is slow
* I'm testing the download from mantid server.
* as the download method I've written is private I can't access that in unit
* testing.
* so adding this public method to call the private download method and
* testing.
*/
std::string testDownload(const std::string &URL, const std::string &fileName);
private:
/// Overwrites Algorithm method.
void init() override;
/// Overwrites Algorithm method
void exec() override;
/// True if the extension of the file is a datafile.
bool isDataFile(const std::string &fileName);
/// Saves the downloaded file to disc
std::string saveFiletoDisk(std::istream &rs, const std::string &fileName);
/// Saves downloaded file to local disk
std::string doDownloadandSavetoLocalDrive(const std::string &URL,
const std::string &fileName);
private:
/// progress indicator
double m_prog;
};
}
}
#endif