ICatalog.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 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/CatalogSession.h"
#include "MantidAPI/ITableWorkspace_fwd.h"
 
#include <string>
#include <vector>
 
namespace Mantid {
namespace ICat {
class CatalogSearchParam;
}
 
namespace API {
class MANTID_API_DLL ICatalog {
public:
  virtual ~ICatalog() = default;
  virtual CatalogSession_sptr login(const std::string &, const std::string &, const std::string &,
                                    const std::string &) = 0;
  virtual void logout() = 0;
  virtual void search(const ICat::CatalogSearchParam &, ITableWorkspace_sptr &, const int &, const int &) = 0;
  virtual int64_t getNumberOfSearchResults(const ICat::CatalogSearchParam &) = 0;
  virtual void myData(ITableWorkspace_sptr &) = 0;
  virtual void getDataSets(const std::string &, ITableWorkspace_sptr &) = 0;
  virtual void getDataFiles(const std::string &, ITableWorkspace_sptr &) = 0;
  virtual void listInstruments(std::vector<std::string> &) = 0;
  virtual void listInvestigationTypes(std::vector<std::string> &) = 0;
  virtual void keepAlive() = 0;
};
 
using ICatalog_sptr = std::shared_ptr<ICatalog>;
using ICatalog_const_sptr = std::shared_ptr<const ICatalog>;
} // namespace API
} // namespace Mantid