IDetector.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2008 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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidGeometry/DllConfig.h"
#include "MantidGeometry/IComponent.h"
#include "MantidGeometry/IDTypes.h"
#include "MantidGeometry/IObjComponent.h"
 
namespace Mantid {
namespace Kernel {
//----------------------------------------------------------------------
// Forward declaration
//----------------------------------------------------------------------
class V3D;
} // namespace Kernel
 
namespace Geometry {
enum det_topology {
  rect, //< rectangular geometry
  cyl,  //< cylindrical geometry
  undef //< the geometry is yet undefined, if you need to know the geometry, a
        // method to identify it must be deployed
};
 
class MANTID_GEOMETRY_DLL IDetector : public virtual IObjComponent {
public:
  virtual IDetector *cloneParameterized(const ParameterMap *map) const = 0;
 
  virtual detid_t getID() const = 0;
 
  virtual std::size_t nDets() const = 0;
 
  double getDistance(const IComponent &comp) const override = 0;
 
  virtual double getTwoTheta(const Kernel::V3D &observer, const Kernel::V3D &axis) const = 0;
 
  virtual double getSignedTwoTheta(const Kernel::V3D &observer, const Kernel::V3D &axis,
                                   const Kernel::V3D &instrumentUp) const = 0;
 
  virtual double getPhi() const = 0;
 
  virtual double getPhiOffset(const double &offset) const = 0;
 
  virtual det_topology getTopology(Kernel::V3D &center) const = 0;
 
  virtual const ParameterMap &parameterMap() const = 0;
  virtual size_t index() const = 0;
 
  IDetector() {} // NOLINT
};
 
using IDetector_sptr = std::shared_ptr<Mantid::Geometry::IDetector>;
using IDetector_const_sptr = std::shared_ptr<const Mantid::Geometry::IDetector>;
 
} // namespace Geometry
} // namespace Mantid