IArchiveSearch.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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/DllConfig.h"
#include "Result.h"
 
#ifndef Q_MOC_RUN
#include <memory>
#endif
#include <filesystem>
#include <set>
#include <string>
#include <vector>
 
#define DECLARE_ARCHIVESEARCH(classname, facility)                                                                     \
  namespace {                                                                                                          \
  Mantid::Kernel::RegistrationHelper register_archive_##facility(                                                      \
      ((Mantid::API::ArchiveSearchFactory::Instance().subscribe<classname>(#facility)), 0));                           \
  }
 
namespace Mantid {
namespace API {
 
class MANTID_API_DLL IArchiveSearch {
public:
  virtual ~IArchiveSearch() = default;
  virtual const Result<std::filesystem::path> getArchivePath(const std::set<std::string> &hintstrs,
                                                             const std::vector<std::string> &exts) const = 0;
};
 
using IArchiveSearch_sptr = std::shared_ptr<IArchiveSearch>;
} // namespace API
} // namespace Mantid