SampleEnvironmentFactory.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2016 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 "MantidDataHandling/DllConfig.h"
#include "MantidDataHandling/SampleEnvironmentSpec.h"
 
namespace Mantid {
namespace DataHandling {
 
class MANTID_DATAHANDLING_DLL ISampleEnvironmentSpecFinder {
public:
  virtual ~ISampleEnvironmentSpecFinder() = default;
  virtual SampleEnvironmentSpec_uptr find(const std::string &facility, const std::string &instrument,
                                          const std::string &name) const = 0;
  virtual SampleEnvironmentSpec_uptr parseSpec(const std::string &name, const std::string &filename) const = 0;
};
// Typedef for a unique_ptr
using ISampleEnvironmentSpecFinder_uptr = std::unique_ptr<ISampleEnvironmentSpecFinder>;
 
class MANTID_DATAHANDLING_DLL SampleEnvironmentFactory {
public:
  SampleEnvironmentFactory() = default;
  SampleEnvironmentFactory(ISampleEnvironmentSpecFinder_uptr specFinder);
 
  Geometry::SampleEnvironment_uptr create(const std::string &facility, const std::string &instrument,
                                          const std::string &specName, const std::string &canName);
 
  size_t cacheSize() const;
  void clearCache();
  SampleEnvironmentSpec_uptr parseSpec(const std::string &filename, const std::string &filepath) const;
 
private:
  ISampleEnvironmentSpecFinder_uptr m_finder;
};
 
//------------------------------------------------------------------------------
// SampleEnvironmentSpecFileFinder
//------------------------------------------------------------------------------
class MANTID_DATAHANDLING_DLL SampleEnvironmentSpecFileFinder final : public ISampleEnvironmentSpecFinder {
public:
  SampleEnvironmentSpecFileFinder(std::vector<std::string> directories);
 
  SampleEnvironmentSpec_uptr find(const std::string &facility, const std::string &instrument,
                                  const std::string &name) const override;
  SampleEnvironmentSpec_uptr parseSpec(const std::string &name, const std::string &filename) const override;
 
private:
  const std::string m_fileext = ".xml";
  const std::vector<std::string> m_rootDirs;
};
 
} // namespace DataHandling
} // namespace Mantid