CatalogHelper.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
 
#include "DllOption.h"
#include "MantidAPI/AlgorithmManager.h"
 
namespace MantidQt {
namespace MantidWidgets {
class EXPORT_OPT_MANTIDQT_COMMON CatalogHelper {
 
public:
  const std::vector<std::string> getInstrumentList(const std::vector<std::string> &sessionIDs);
  const std::vector<std::string> getInvestigationTypeList(const std::vector<std::string> &sessionIDs);
  void executeSearch(const std::map<std::string, std::string> &userInputs, const int &offset, const int &limit,
                     const std::vector<std::string> &sessionIDs);
  int64_t getNumberOfSearchResults(const std::map<std::string, std::string> &userInputFields,
                                   const std::vector<std::string> &sessionIDs);
  void executeGetDataFiles(const std::string &investigationId, const std::string &sessionID);
  const std::vector<std::string>
  downloadDataFiles(const std::vector<std::pair<int64_t, std::string>> &userSelectedFiles,
                    const std::string &downloadPath, const std::string &sessionID);
  const std::map<std::string, std::string> validateProperties(const std::map<std::string, std::string> &inputFields);
  time_t getTimevalue(const std::string &inputDate);
  void showLoginDialog();
  void showPublishDialog();
 
private:
  Mantid::API::IAlgorithm_sptr createCatalogAlgorithm(const std::string &algName);
  const std::string propertyDocumentation(const std::vector<Mantid::Kernel::Property *> &properties,
                                          const std::string &name);
  void executeAsynchronously(const Mantid::API::IAlgorithm_sptr &algorithm);
  void setSearchProperties(const Mantid::API::IAlgorithm_sptr &catalogAlgorithm,
                           const std::map<std::string, std::string> &userInputFields);
};
} // namespace MantidWidgets
} // namespace MantidQt