SaveOpenGenieAscii.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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
 
//---------------------------------------------------
// Includes
//---------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidDataHandling/DllConfig.h"
#include <iosfwd>
 
namespace Mantid {
namespace DataHandling {
 
class MANTID_DATAHANDLING_DLL SaveOpenGenieAscii : public Mantid::API::Algorithm {
public:
  SaveOpenGenieAscii() = default;
  ~SaveOpenGenieAscii() = default;
 
  const std::string name() const override { return "SaveOpenGenieAscii"; }
 
  const std::string summary() const override { return "Saves a focused data set into an OpenGenie ASCII file "; }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override { return {"SaveAscii"}; }
 
  const std::string category() const override { return "Diffraction\\DataHandling;DataHandling\\Text"; }
 
private:
  using OutputBufferEntry = std::tuple<std::string, std::string, std::string>;
 
  void init() override;
 
  void exec() override;
 
  inline void addToOutputBuffer(const std::string &outName, const std::string &outType, const std::string &outVal) {
    m_outputVector.emplace_back(OutputBufferEntry(outName, outType, outVal));
  }
 
  void applyEnginxFormat();
 
  void calculateXYZDelta(const std::string &unit, const Kernel::Property *values);
 
  template <typename T> void convertWorkspaceData(const T &histoData, const char &axis);
 
  void determineEnginXBankId();
 
  void getSampleLogs();
 
  void inputValidation();
 
  void openFileStream(std::ofstream &stream);
 
  void storeEmptyFields();
 
  void storeWorkspaceInformation();
 
  void writeDataToFile(std::ofstream &outfile);
 
  std::vector<OutputBufferEntry> m_outputVector;
  API::MatrixWorkspace_const_sptr m_inputWS;
  const std::string m_stringType = "String";
  const std::string m_floatType = "Float";
  const std::string m_intType = "Integer";
};
} // namespace DataHandling
} // namespace Mantid