IComponent.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/IComponent.h"
#include "MantidKernel/Quat.h"
#include "MantidPythonInterface/core/GetPointer.h"
 
#include <boost/python/class.hpp>
#include <boost/python/copy_const_reference.hpp>
#include <boost/python/register_ptr_to_python.hpp>
#include <boost/python/return_value_policy.hpp>
 
using Mantid::Geometry::IComponent;
using namespace boost::python;
 
GET_POINTER_SPECIALIZATION(IComponent)
 
namespace {
double getDistance(const IComponent &self, const IComponent &other) { return self.getDistance(other); }
} // namespace
 
void export_IComponent() {
  register_ptr_to_python<std::shared_ptr<IComponent>>();
  register_ptr_to_python<std::shared_ptr<const IComponent>>();
 
  class_<IComponent, boost::noncopyable>("IComponent", no_init)
      .def("getPos", &IComponent::getPos, arg("self"), "Returns the absolute position of the component")
      .def("getDistance", &getDistance, (arg("self"), arg("other")),
           "Returns the distance, in metres, "
           "between this and the given component")
      .def("getName", &IComponent::getName, arg("self"), "Returns the name of the component")
      .def("getFullName", &IComponent::getFullName, arg("self"), "Returns full path name of component")
      .def("type", &IComponent::type, arg("self"), "Returns the type of the component represented as a string")
      .def("getRelativeRot", &IComponent::getRelativeRot, arg("self"), "Returns the relative rotation as a Quat");
}