SaveCanSAS1D.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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidDataHandling/DllConfig.h"
#include <fstream>
 
namespace Poco {
namespace XML {
class Document;
class Element;
class Text;
} // namespace XML
} // namespace Poco
 
namespace Mantid {
namespace DataHandling {
class MANTID_DATAHANDLING_DLL SaveCanSAS1D : public API::Algorithm {
public:
  virtual ~SaveCanSAS1D() = default;
  const std::string name() const override { return "SaveCanSAS1D"; }
  const std::string summary() const override { return "Save a MatrixWorkspace to a file in the canSAS 1-D format"; }
  int version() const override { return 1; }
  const std::string category() const override { return "DataHandling\\XML;SANS\\DataHandling"; }
 
protected:
  void init() override;
  void setOtherProperties(API::IAlgorithm *alg, const std::string &propertyName, const std::string &propertyValue,
                          int perioidNum) override;
  void exec() override;
 
  void prepareFileToWriteEntry(const std::string &fileName);
  bool openForAppending(const std::string &filename);
  void findEndofLastEntry();
  virtual void writeHeader(const std::string &fileName);
  void searchandreplaceSpecialChars(std::string &input);
  void replacewithEntityReference(std::string &input, const std::string::size_type &index);
  virtual void createSASRootElement(std::string &rootElem);
 
  void createSASTitleElement(std::string &sasTitle);
 
  void createSASSampleElement(std::string &sasSample);
 
  void createSASRunElement(std::string &sasRun);
 
  void createSASDataElement(std::string &sasData, size_t workspaceIndex);
 
  void createSASSourceElement(std::string &sasSource);
 
  void createSASDetectorElement(std::string &sasDet);
 
  void createSASProcessElement(std::string &sasProcess);
 
  void createSASInstrument(std::string &sasInstrument);
 
  API::MatrixWorkspace_const_sptr m_workspace;
  std::fstream m_outFile;
};
} // namespace DataHandling
} // namespace Mantid