IComponent.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/Objects/BoundingBox.h"
#include "MantidKernel/V2D.h"
#include "MantidKernel/V3D.h"
 
#include <map>
#include <optional>
#include <set>
#include <string>
#include <vector>
 
#ifndef Q_MOC_RUN
#include <memory>
#endif
 
namespace Mantid {
 
namespace Kernel {
class Quat;
}
 
namespace Geometry {
class IComponent;
class ParameterMap;
 
using ComponentID = IComponent *;
 
class MANTID_GEOMETRY_DLL IComponent {
public:
  virtual std::string type() const { return "LogicalComponent"; }
  virtual IComponent *clone() const = 0;
  virtual ~IComponent() = default;
  virtual ComponentID getComponentID() const = 0;
  // or pointer to itself if not. Currently is the same as getComponentID bar
  // const cast;
  virtual IComponent const *getBaseComponent() const = 0;
  virtual void setParent(IComponent *) = 0;
  virtual std::shared_ptr<const IComponent> getParent() const = 0;
  virtual const IComponent *getBareParent() const = 0;
  virtual std::vector<std::shared_ptr<const IComponent>> getAncestors() const = 0;
  virtual void setName(const std::string &) = 0;
  virtual std::string getName() const = 0;
  virtual std::string getFullName() const = 0;
  // otherwise absolute
  virtual void setPos(double, double, double) = 0;
  virtual void setPos(const Kernel::V3D &) = 0;
  virtual void setSideBySideViewPos(const Kernel::V2D &) = 0;
  // otherwise absolute
  virtual void setRot(const Kernel::Quat &) = 0;
  // virtual void copyRot(const IComponent&) = 0;
  // present.
  virtual void translate(const Kernel::V3D &) = 0;
  // present.
  virtual void translate(double, double, double) = 0;
  virtual void rotate(const Kernel::Quat &) = 0;
  virtual void rotate(double, const Kernel::V3D &) = 0;
  virtual Kernel::V3D getRelativePos() const = 0;
  // parent chain
  virtual Kernel::V3D getPos() const = 0;
  virtual std::optional<Kernel::V2D> getSideBySideViewPos() const = 0;
  virtual Kernel::Quat getRelativeRot() const = 0;
  virtual Kernel::Quat getRotation() const = 0;
  virtual double getDistance(const IComponent &) const = 0;
  virtual void getBoundingBox(BoundingBox &boundingBox) const = 0;
 
  virtual Kernel::V3D getScaleFactor() const { return Kernel::V3D(1.0, 1.0, 1.0); }
 
  virtual std::set<std::string> getParameterNames(bool recursive = true) const = 0;
  virtual std::map<std::string, ComponentID> getParameterNamesByComponent() const = 0;
  virtual bool hasParameter(const std::string &name, bool recursive = true) const = 0;
  // Hack until proper python export functions are defined
  virtual std::string getParameterType(const std::string &pname, bool recursive = true) const = 0;
  // 06/05/2010 MG: Templated virtual functions cannot be defined so we have to
  // resort to
  // one for each type, luckily there won't be too many
  virtual std::vector<double> getNumberParameter(const std::string &pname, bool recursive = true) const = 0;
  virtual std::vector<Kernel::V3D> getPositionParameter(const std::string &pname, bool recursive = true) const = 0;
  virtual std::vector<Kernel::Quat> getRotationParameter(const std::string &pname, bool recursive = true) const = 0;
  virtual std::vector<std::string> getStringParameter(const std::string &pname, bool recursive = true) const = 0;
  virtual std::vector<int> getIntParameter(const std::string &pname, bool recursive = true) const = 0;
  virtual std::vector<bool> getBoolParameter(const std::string &pname, bool recursive = true) const = 0;
  virtual std::string getParameterAsString(const std::string &pname, bool recursive = true) const = 0;
  virtual bool getParameterVisible(const std::string &pname, bool recursive = true) const = 0;
 
  virtual void printSelf(std::ostream &) const = 0;
  virtual bool isParametrized() const = 0;
  virtual size_t registerContents(class ComponentVisitor &component) const = 0;
};
 
using IComponent_sptr = std::shared_ptr<IComponent>;
using IComponent_const_sptr = std::shared_ptr<const IComponent>;
 
} // Namespace Geometry
 
class NoDeleting {
public:
  void operator()(void *) {}
  void operator()(const void *) {}
};
 
} // Namespace Mantid