LoadCanSAS1D.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "MantidAPI/IFileLoader.h"
#include "MantidAPI/WorkspaceGroup_fwd.h"
#include "MantidDataHandling/DllConfig.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidKernel/FileDescriptor.h"
 
#include <Poco/DOM/Element.h>
#include <Poco/DOM/Node.h>
 
namespace Poco {
namespace XML {
class Element;
}
} // namespace Poco
 
namespace Mantid {
namespace DataHandling {
class MANTID_DATAHANDLING_DLL LoadCanSAS1D : public API::IFileLoader<Kernel::FileDescriptor> {
public:
  const std::string name() const override { return "LoadCanSAS1D"; }
  const std::string summary() const override { return "Load a file written in the canSAS 1-D data format"; }
 
  int version() const override { return 1; }
  const std::string category() const override { return "DataHandling\\XML;SANS\\DataHandling"; }
 
  int confidence(Kernel::FileDescriptor &descriptor) const override;
 
protected:
  std::string m_groupMembersBase;
  int m_groupNumber = 0;
 
  void init() override;
  void exec() override;
 
  virtual API::MatrixWorkspace_sptr loadEntry(Poco::XML::Node *const workspaceData, std::string &runName);
  void check(const Poco::XML::Element *const toCheck, const std::string &name) const;
  void appendDataToOutput(const API::MatrixWorkspace_sptr &newWork, const std::string &newWorkName,
                          const API::WorkspaceGroup_sptr &container);
  void runLoadInstrument(const std::string &inst_name, const API::MatrixWorkspace_sptr &localWorkspace);
  void createLogs(const Poco::XML::Element *const sasEntry, const API::MatrixWorkspace_sptr &wSpace) const;
  void createSampleInformation(const Poco::XML::Element *const sasEntry,
                               const Mantid::API::MatrixWorkspace_sptr &wSpace) const;
};
} // namespace DataHandling
} // namespace Mantid