NexusFileLoader.h

// 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
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once

#include "MantidAPI/IFileLoader.h"
#include "MantidKernel/DllConfig.h"
#include "MantidKernel/NexusHDF5Descriptor.h"

namespace Mantid::API {

class MANTID_API_DLL NexusFileLoader
    : public API::IFileLoader<Mantid::Kernel::NexusHDF5Descriptor> {
public:
  void
  exec() override final; // makes sure the NexusHDF5Descriptor is initialized
  virtual void execLoader() = 0; // what would normally be called exec
  // the name of the property that the NexusHDF5Descriptor should be created
  // against

  virtual std::string getFilenamePropertyName() const;
  std::shared_ptr<Algorithm> createChildAlgorithm(
      const std::string &name, const double startProgress = -1.,
      const double endProgress = -1., const bool enableLogging = true,
      const int &version = -1) override;
  virtual void
  setFileInfo(std::shared_ptr<Mantid::Kernel::NexusHDF5Descriptor> fileInfo);

  /// Required to pass m_fileInfo to static functions
  /// Keeping it shared_ptr to match setFileInfo signature (although passing
  /// ownership is not the main goal).
  virtual const std::shared_ptr<Mantid::Kernel::NexusHDF5Descriptor>
  getFileInfo() const noexcept;

  virtual int
  confidence(Kernel::NexusHDF5Descriptor &descriptor) const override = 0;

private:
  std::shared_ptr<Mantid::Kernel::NexusHDF5Descriptor> m_fileInfo;
};
} // namespace Mantid::API