NexusDescriptor.h

Go to the documentation of this file.

// 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 & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "MantidKernel/DllConfig.h"
 
#include <map>
#include <memory>
#include <string>
#include <unordered_set>
#include <utility>
 
namespace NeXus {
class File;
}
 
namespace Mantid {
namespace Kernel {
 
class MANTID_KERNEL_DLL NexusDescriptor {
public:
  enum Version { Version4, Version5, AnyVersion };
 
  static const size_t HDFMagicSize;
  static const unsigned char HDFMagic[4];
  static size_t HDF5SignatureSize;
  static const unsigned char HDF5Signature[8];
 
  static bool isReadable(const std::string &filename, const Version version = AnyVersion);
 
public:
  NexusDescriptor(const std::string &filename, const bool init = true);
  ~NexusDescriptor();
 
  NexusDescriptor() = delete;
 
  NexusDescriptor(const NexusDescriptor &) = delete;
 
  NexusDescriptor &operator=(const NexusDescriptor &) = delete;
 
  inline const std::string &filename() const { return m_filename; }
  inline const std::string &extension() const { return m_extension; }
  inline ::NeXus::File &data() { return *m_file; }
 
  const std::pair<std::string, std::string> &firstEntryNameType() const;
  bool hasRootAttr(const std::string &name) const;
  bool pathExists(const std::string &path) const;
  bool pathOfTypeExists(const std::string &path, const std::string &type) const;
  std::string pathOfType(const std::string &type) const;
  bool classTypeExists(const std::string &classType) const;
 
private:
  void initialize(const std::string &filename);
  void walkFile(::NeXus::File &file, const std::string &rootPath, const std::string &className,
                std::map<std::string, std::string> &pmap, int level);
 
  std::string m_filename;
  std::string m_extension;
  std::pair<std::string, std::string> m_firstEntryNameType;
  std::unordered_set<std::string> m_rootAttrs;
  std::map<std::string, std::string> m_pathsToTypes;
 
  std::unique_ptr<::NeXus::File> m_file;
};
 
} // namespace Kernel
} // namespace Mantid