Mantid
Loading...
Searching...
No Matches
SavePHX.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2009 ISIS Rutherford Appleton Laboratory UKRI,
4// NScD Oak Ridge National Laboratory, European Spallation Source,
5// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
6// SPDX - License - Identifier: GPL - 3.0 +
7#pragma once
8
10#include "MantidDataHandling/DllConfig.h"
11
12namespace Mantid {
13namespace DataHandling {
30class MANTID_DATAHANDLING_DLL SavePHX : public Mantid::API::Algorithm {
31public:
33 const std::string name() const override { return "SavePHX"; }
35 const std::string summary() const override {
36 return "Writes the detector geometry information of a workspace into a PHX "
37 "format file.";
38 }
39
41 int version() const override { return (1); }
42 const std::vector<std::string> seeAlso() const override { return {"SaveSPE"}; }
44 const std::string category() const override { return "DataHandling\\SPE;Inelastic\\DataHandling"; }
45
52 void set_resulting_workspace(const std::string &ws_name) { det_par_ws_name = ws_name; }
53
54private:
56 void init() override;
58 void exec() override;
60 std::string det_par_ws_name;
61};
62} // namespace DataHandling
63} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Saves a workspace into an ASCII PHX file.
Definition: SavePHX.h:30
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
Definition: SavePHX.h:42
int version() const override
Algorithm's version.
Definition: SavePHX.h:41
const std::string summary() const override
Summary of algorithms purpose.
Definition: SavePHX.h:35
const std::string name() const override
Algorithm's name.
Definition: SavePHX.h:33
std::string det_par_ws_name
The name of the table workpsace with detectors positions used in tests.
Definition: SavePHX.h:60
void set_resulting_workspace(const std::string &ws_name)
the method used in tests.
Definition: SavePHX.h:52
const std::string category() const override
Algorithm's category for identification.
Definition: SavePHX.h:44
Helper class which provides the Collimation Length for SANS instruments.