ImportMDEventWorkspace.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2012 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/Algorithm.h"
#include "MantidDataObjects/MDEventWorkspace.h"
#include "MantidMDAlgorithms/DllConfig.h"
#include <deque>
 
namespace Mantid {
namespace MDAlgorithms {
 
class MANTID_MDALGORITHMS_DLL ImportMDEventWorkspace final : public API::Algorithm {
public:
  const std::string name() const override;
  const std::string summary() const override {
    return "Reads an ASCII file containing MDEvent data and constructs an "
           "MDEventWorkspace.";
  }
 
  int version() const override;
  const std::vector<std::string> seeAlso() const override { return {"ImportMDHistoWorkspace"}; }
  const std::string category() const override;
 
  static const std::string DimensionBlockFlag();
  static const std::string MDEventBlockFlag();
  static const std::string CommentLineStartFlag();
 
private:
  using DataCollectionType = std::deque<std::string>;
  DataCollectionType m_file_data;
  DataCollectionType::iterator m_posDimStart;
  DataCollectionType::iterator m_posMDEventStart;
  enum MDEventType { Lean, Full, NotSpecified };
  bool m_IsFullDataObjects = false;
  size_t m_nDimensions = 0;
  size_t m_nDataObjects = 0;
  template <typename MDE, size_t nd> void addEventsData(typename DataObjects::MDEventWorkspace<MDE, nd>::sptr ws);
  void quickFileCheck();
  bool fileDoesContain(const std::string &flag);
 
  void init() override;
  void exec() override;
};
 
} // namespace MDAlgorithms
} // namespace Mantid