SampleEnvironmentSpec.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2016 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 "MantidDataHandling/DllConfig.h"
#include "MantidGeometry/Instrument/Container.h"
#include "MantidGeometry/Instrument/SampleEnvironment.h"
 
#include <string>
#include <unordered_map>
#include <vector>
 
namespace Mantid {
namespace DataHandling {
 
class MANTID_DATAHANDLING_DLL SampleEnvironmentSpec {
public:
  // Convenience typedefs
  using ContainerIndex = std::unordered_map<std::string, Geometry::Container_const_sptr>;
  using ComponentList = std::vector<Geometry::IObject_const_sptr>;
 
  SampleEnvironmentSpec(std::string name);
 
  inline const std::string &name() const { return m_name; }
  inline size_t ncans() const { return m_cans.size(); }
  inline size_t ncomponents() const { return m_components.size(); }
  Geometry::Container_const_sptr findContainer(const std::string &id) const;
 
  Geometry::SampleEnvironment_uptr buildEnvironment(const std::string &canID) const;
 
  void addContainer(const Geometry::Container_const_sptr &can);
  void addComponent(const Geometry::IObject_const_sptr &component);
 
private:
  std::string m_name;
  ContainerIndex m_cans;
  ComponentList m_components;
};
 
using SampleEnvironmentSpec_uptr = std::unique_ptr<SampleEnvironmentSpec>;
using SampleEnvironmentSpec_const_uptr = std::unique_ptr<const SampleEnvironmentSpec>;
 
} // namespace DataHandling
} // namespace Mantid