Mantid
Loading...
Searching...
No Matches
LoadSNSspec.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2007 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
9//----------------------------------------------------------------------
10// Includes
11//----------------------------------------------------------------------
14#include "MantidDataHandling/DllConfig.h"
16
17namespace Mantid {
18namespace DataHandling {
35class MANTID_DATAHANDLING_DLL LoadSNSspec : public API::IFileLoader<Kernel::FileDescriptor>, API::DeprecatedAlgorithm {
36public:
38 const std::string name() const override { return "LoadSNSspec"; }
40 const std::string summary() const override {
41 return "Loads data from a text file and stores it in a 2D workspace "
42 "(Workspace2D class).";
43 }
44
45 int version() const override { return 1; }
46 const std::vector<std::string> seeAlso() const override { return {"LoadSpec"}; }
47 const std::string category() const override { return "DataHandling\\Text"; }
48
50 int confidence(Kernel::FileDescriptor &descriptor) const override;
51
52private:
53 void init() override;
54 void exec() override;
55
57 std::vector<std::string> m_seperator_options;
58 std::map<std::string, const char *> m_separatormap;
59 using separator_pair = std::pair<std::string, const char *>;
60};
61
62} // namespace DataHandling
63} // namespace Mantid
Class for marking algorithms as deprecated.
Defines an interface to an algorithm that loads a file so that it can take part in the automatic sele...
Definition: IFileLoader.h:19
Loads a workspace from an SNS spec file.
Definition: LoadSNSspec.h:35
int version() const override
function to return a version of the algorithm, must be overridden in all algorithms
Definition: LoadSNSspec.h:45
std::map< std::string, const char * > m_separatormap
a map of seperators
Definition: LoadSNSspec.h:58
const std::string summary() const override
Summary of algorithms purpose.
Definition: LoadSNSspec.h:40
std::pair< std::string, const char * > separator_pair
serparator pair type def
Definition: LoadSNSspec.h:59
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: LoadSNSspec.h:46
std::vector< std::string > m_seperator_options
Allowed values for the cache property.
Definition: LoadSNSspec.h:57
const std::string name() const override
function to return a name of the algorithm, must be overridden in all algorithms
Definition: LoadSNSspec.h:38
const std::string category() const override
function to return a category of the algorithm.
Definition: LoadSNSspec.h:47
Defines a wrapper around an open file.
Helper class which provides the Collimation Length for SANS instruments.