-
Notifications
You must be signed in to change notification settings - Fork 122
/
SaveAscii2.h
81 lines (66 loc) · 3.13 KB
/
SaveAscii2.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 MANTID_DATAHANDLING_SaveAscii2_H_
#define MANTID_DATAHANDLING_SaveAscii2_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
namespace Mantid
{
namespace DataHandling
{
/** @class SaveAscii2 SaveAscii2.h DataHandling/SaveAscii2.h
Saves a workspace or selected spectra in a coma-separated ascii file. Spectra are saved in columns.
Properties:
<ul>
<li>Filename - the name of the file to write to. </li>
<li>Workspace - the workspace name to be saved.</li>
<li>SpectrumMin - the starting spectrum index to save (optional) </li>
<li>SpectrumMax - the ending spectrum index to save (optional) </li>
<li>SpectrumList - a list of comma-separated spectra indeces to save (optional) </li>
<li>Precision - the numeric precision - the number of significant digits for the saved data (optional) </li>
</ul>
@author Keith Brown, ISIS, Placement student from the University of Derby
@date 10/10/13
Copyright © 2007-9 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory
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 SaveAscii2 : public API::Algorithm
{
public:
/// Default constructor
SaveAscii2();
/// Destructor
~SaveAscii2() {}
/// Algorithm's name for identification overriding a virtual method
virtual const std::string name() const { return "SaveAscii"; }
/// Algorithm's version for identification overriding a virtual method
virtual int version() const { return 2; }
/// Algorithm's category for identification overriding a virtual method
virtual const std::string category() const { return "DataHandling\\Text"; }
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Overwrites Algorithm method.
void init();
/// Overwrites Algorithm method
void exec();
///static reference to the logger class
static Kernel::Logger& g_log;
/// Map the separator options to their string equivalents
std::map<std::string,std::string> m_separatorIndex;
};
} // namespace DataHandling
} // namespace Mantid
#endif /* MANTID_DATAHANDLING_SaveAscii2_H_ */