CatalogPublish.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2013 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 "MantidAPI/ICatalogInfoService.h"
#include "MantidICat/CatalogAlgorithmHelper.h"
#include "MantidICat/DllConfig.h"
 
namespace Mantid {
namespace ICat {
class MANTID_ICAT_DLL CatalogPublish final : public API::Algorithm {
public:
  CatalogPublish() : API::Algorithm() {}
  ~CatalogPublish() override = default;
  const std::string name() const override { return "CatalogPublish"; }
  const std::string summary() const override {
    return "Allows the user to publish datafiles or workspaces to the "
           "information catalog.";
  }
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"CatalogLogin"}; }
  const std::string category() const override { return "DataHandling\\Catalog"; }
 
private:
  void init() override;
  void exec() override;
  void publish(std::istream &fileContents, const std::string &uploadURL);
  bool checkGroups() override { return false; }
  bool isDataFile(const std::string &filePath);
  void saveWorkspaceToNexus(Mantid::API::Workspace_sptr &workspace);
  void publishWorkspaceHistory(Mantid::API::ICatalogInfoService_sptr &catalogInfoService,
                               Mantid::API::Workspace_sptr &workspace);
  const std::string generateWorkspaceHistory(Mantid::API::Workspace_sptr &workspace);
};
} // namespace ICat
} // namespace Mantid