// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2019 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/Algorithm.h"
#include "MantidDataHandling/DllConfig.h"
#include "MantidDataHandling/LoadNexusProcessed.h"
#include "MantidGeometry/IDTypes.h"
#include "MantidIndexing/SpectrumNumber.h"
#include "MantidKernel/NexusDescriptor.h"
#include <string>

namespace Mantid {
namespace API {
class Workspace;
class MatrixWorkspace;
} // namespace API
namespace NeXus {
class NXEntry;
}
namespace DataHandling {
/// Layout information relating to detector-spectra mappings
enum class InstrumentLayout { Mantid, NexusFormat, NotRecognised };

/** LoadNexusProcessed2 : Second variation of LoadNexusProcess, built to handle
 * ESS file specifics in addition to existing behaviour for standard Mantid
 * Processed files.
 *
 * The majority of the implementation consists of function overrides for
 * specific virtual hooks make in the base Algorithm LoadNexusProcessed
 */
class MANTID_DATAHANDLING_DLL LoadNexusProcessed2 : public LoadNexusProcessed {
public:
  const std::string name() const override;
  int version() const override;
  int confidence(Kernel::NexusDescriptor &descriptor) const override;

private:
  void readSpectraToDetectorMapping(Mantid::NeXus::NXEntry &mtd_entry,
                                    Mantid::API::MatrixWorkspace &ws) override;
  bool loadNexusGeometry(Mantid::API::Workspace &ws,
                         const int nWorkspaceEntries, Kernel::Logger &logger,
                         const std::string &filename) override;
  /// Extract mapping information where it is build across NXDetectors
  void extractMappingInfoNew(Mantid::NeXus::NXEntry &mtd_entry);
  /// Load nexus geometry and apply to workspace
  /// Local caches
  InstrumentLayout m_instrumentLayout = InstrumentLayout::Mantid;
  std::vector<Indexing::SpectrumNumber> m_spectrumNumbers;
  std::vector<Mantid::detid_t> m_detectorIds;
  std::vector<int> m_detectorCounts;
};

} // namespace DataHandling
} // namespace Mantid