ICompAssembly.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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 "MantidGeometry/IComponent.h"
#include <deque>
#include <string>
#include <vector>
 
namespace Mantid {
namespace Geometry {
// Forward declaration
class Track;
 
class MANTID_GEOMETRY_DLL ICompAssembly : public virtual IComponent {
public:
  // Default constructor;
  // Fixes warning C4436 on Windows.
  ICompAssembly(){};
  std::string type() const override { return "ICompAssembly"; }
  IComponent *clone() const override = 0;
  virtual int nelements() const = 0;
  virtual int add(IComponent *) = 0;
  virtual int addCopy(IComponent *) = 0;
  virtual int addCopy(IComponent *, const std::string &) = 0;
  virtual std::shared_ptr<IComponent> getChild(const int i) const = 0;
  virtual std::shared_ptr<const IComponent> getComponentByName(const std::string &cname, int nlevels = 0) const = 0;
  virtual void getChildren(std::vector<IComponent_const_sptr> &outVector, bool recursive) const = 0;
  virtual std::shared_ptr<IComponent> operator[](int i) const = 0;
  virtual void printChildren(std::ostream &) const = 0;
  virtual void printTree(std::ostream &) const = 0;
 
  virtual void testIntersectionWithChildren(Track &testRay, std::deque<IComponent_const_sptr> &searchQueue) const = 0;
 
protected:
  ICompAssembly(const ICompAssembly &) = default;
 
private:
  ICompAssembly &operator=(const ICompAssembly &) = delete;
};
 
using ICompAssembly_sptr = std::shared_ptr<ICompAssembly>;
using ICompAssembly_const_sptr = std::shared_ptr<const ICompAssembly>;
 
} // Namespace Geometry
} // Namespace Mantid