NexusDescriptor.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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 "MantidNexus/DllConfig.h"
 
#include <map>
#include <set>
#include <string>
#include <unordered_set>
#include <vector>
 
// from NexusFile_fwd.h
enum class NXaccess : unsigned int;
 
namespace Mantid {
namespace Nexus {
 
class MANTID_NEXUS_DLL NexusDescriptor {
 
public:
  NexusDescriptor(std::string const &filename);
 
  NexusDescriptor(std::string const &filename, NXaccess access);
 
  NexusDescriptor() = delete;
 
  NexusDescriptor &operator=(NexusDescriptor const &nd) = default;
 
  NexusDescriptor(NexusDescriptor const &nd) = default;
 
  ~NexusDescriptor() = default;
 
  const std::string &filename() const noexcept;
 
  inline const std::string &extension() const { return m_extension; }
 
  const std::pair<std::string, std::string> &firstEntryNameType() const { return m_firstEntryNameType; };
 
  bool hasRootAttr(const std::string &name) const;
 
  const std::map<std::string, std::set<std::string>> &getAllEntries() const noexcept;
 
  bool isEntry(const std::string &entryName, const std::string &groupClass) const noexcept;
 
  bool isEntry(const std::string &entryName) const noexcept;
 
  std::vector<std::string> allAddressesOfType(const std::string &type) const;
 
  std::map<std::string, std::string> allAddressesAtLevel(const std::string &level) const;
 
  bool classTypeExists(const std::string &classType) const;
 
  std::string classTypeForName(std::string const &name) const;
 
  void addEntry(const std::string &entryName, const std::string &groupClass);
 
  void addRootAttr(const std::string &name);
 
private:
  std::map<std::string, std::set<std::string>> initAllEntries();
 
  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::set<std::string>> m_allEntries;
};
 
} // namespace Nexus
} // namespace Mantid