InstrumentMetadata.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2026 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 "MantidGeometry/DllConfig.h"
#include "MantidTypes/Core/DateAndTime.h"
#include <memory>
#include <string>
 
namespace Mantid {
namespace Geometry {
class ComponentInfo;
class DetectorInfo;
 
class MANTID_GEOMETRY_DLL InstrumentMetadata {
public:
  InstrumentMetadata(const Types::Core::DateAndTime &validFromDate, const Types::Core::DateAndTime &validToDate,
                     const std::string &filename, const std::string &xmlText, const std::string &defaultView,
                     const std::string &defaultAxis,
                     const std::shared_ptr<const ComponentInfo> &physicalComponentInfo = nullptr,
                     const std::shared_ptr<const DetectorInfo> &physicalDetectorInfo = nullptr);
 
  const Types::Core::DateAndTime &validFromDate() const;
  const Types::Core::DateAndTime &validToDate() const;
  const std::string &filename() const;
  const std::string &xmlText() const;
  const std::string &defaultView() const;
  const std::string &defaultAxis() const;
  bool hasPhysicalInstrument() const;
  const ComponentInfo &physicalComponentInfo() const;
  const DetectorInfo &physicalDetectorInfo() const;
 
  void setFileName(const std::string &filename);
  void setXmlText(const std::string &xmlText);
  void setDefaultView(const std::string &defaultView);
  void setDefaultViewAxis(const std::string &defaultAxis);
 
private:
  Types::Core::DateAndTime m_validFromDate;
  Types::Core::DateAndTime m_validToDate;
  std::string m_filename;
  std::string m_xmlText;
  std::string m_defaultView;
  std::string m_defaultAxis;
  // The ComponentInfo is cross-linked to the DetectorInfo, so the two are always held together
  std::shared_ptr<const ComponentInfo> m_physicalComponentInfo;
  std::shared_ptr<const DetectorInfo> m_physicalDetectorInfo;
};
 
} // namespace Geometry
} // namespace Mantid