IObjComponent.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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 +
#include "MantidGeometry/IObjComponent.h"
#include "MantidPythonInterface/core/GetPointer.h"
#include <boost/python/class.hpp>
#include <boost/python/register_ptr_to_python.hpp>
 
using Mantid::Geometry::IComponent;
using Mantid::Geometry::IObjComponent;
using namespace boost::python;
 
GET_POINTER_SPECIALIZATION(IObjComponent)
 
namespace {
std::shared_ptr<Mantid::Geometry::IObject> getShape(const IObjComponent &self) {
  if (PyErr_Warn(PyExc_DeprecationWarning,
                 "'IObjComponent.shape' is deprecated in Mantid 7.0, "
                 "use 'ComponentInfo.shape' instead. "
                 "For more information, see the instrument access layers concept page: "
                 "https://docs.mantidproject.org/nightly/concepts/InstrumentAccessLayers.html") < 0)
    throw boost::python::error_already_set();
  return std::const_pointer_cast<Mantid::Geometry::IObject>(self.shape());
}
} // namespace
 
void export_IObjComponent() {
  register_ptr_to_python<std::shared_ptr<IObjComponent>>();
 
  class_<IObjComponent, boost::python::bases<IComponent>, boost::noncopyable>("IObjComponent", no_init)
      .def("shape", &getShape, arg("self"),
           "Get the object that represents "
           "the physical shape of this "
           "component (deprecated, use ComponentInfo.shape)");
}