NexusAddress.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 <filesystem>
#include <memory>
#include <vector>
 
namespace Mantid::Nexus {
 
class MANTID_NEXUS_DLL NexusAddress {
 
public:
  NexusAddress(std::filesystem::path const &p);
 
  NexusAddress(std::string const &p);
 
  NexusAddress(char const *const p);
 
  NexusAddress();
 
  NexusAddress &operator=(NexusAddress const &nd) = default;
 
  NexusAddress &operator=(std::string const &s);
 
  NexusAddress(NexusAddress const &nd) = default;
 
  ~NexusAddress() = default;
 
  // comparison operators
 
  bool operator==(NexusAddress const &p) const;
 
  bool operator==(std::string const &s) const;
 
  bool operator==(char const *const s) const;
 
  bool operator!=(NexusAddress const &p) const;
 
  bool operator!=(std::string const &s) const;
 
  bool operator!=(char const *const s) const;
 
  // concatenation
 
  NexusAddress operator/(std::string const &s) const;
 
  NexusAddress operator/(char const *const s) const;
 
  NexusAddress operator/(NexusAddress const &p) const;
 
  NexusAddress &operator/=(std::string const &s);
 
  NexusAddress &operator/=(char const *const s);
 
  NexusAddress &operator/=(NexusAddress const &p);
 
  // access
 
  bool isAbsolute() const;
 
  bool isRoot() const;
 
  NexusAddress parent_path() const;
 
  NexusAddress fromRoot() const;
 
  NexusAddress stem() const;
 
  static NexusAddress root();
 
  std::vector<std::string> parts() const;
 
  // printing
 
  std::string operator+(std::string const &s) const;
 
  std::string operator+(char const s[]) const;
 
  operator std::string() const { return m_resolved_path; }
 
  std::string const &string() const { return m_resolved_path; }
 
  char const *c_str() const { return m_resolved_path.c_str(); }
 
private:
  std::filesystem::path m_path;
  // in order to return c_str from the generic_string, this must remain in memory
  std::string m_resolved_path;
};
 
} // namespace Mantid::Nexus
 
MANTID_NEXUS_DLL bool operator==(std::string const &s, Mantid::Nexus::NexusAddress const &p);
 
MANTID_NEXUS_DLL bool operator!=(std::string const &s, Mantid::Nexus::NexusAddress const &p);
 
MANTID_NEXUS_DLL std::string operator+(std::string const &s, Mantid::Nexus::NexusAddress const &p);
 
MANTID_NEXUS_DLL std::string operator+(char const s[], Mantid::Nexus::NexusAddress const &p);
 
MANTID_NEXUS_DLL std::ostream &operator<<(std::ostream &os, Mantid::Nexus::NexusAddress const &p);