IMDDimension.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/MDGeometry/MDFrame.h"
#include "MantidGeometry/MDGeometry/MDTypes.h"
#include "MantidKernel/MDUnit.h"
#include "MantidKernel/V3D.h"
#ifndef Q_MOC_RUN
#include <memory>
#endif
#include <stdexcept>
#include <vector>
 
namespace Mantid {
namespace Kernel {
//---------------------------------------------------------------------------
// Forward declarations
//---------------------------------------------------------------------------
class UnitLabel;
} // namespace Kernel
 
namespace Geometry {
class MANTID_GEOMETRY_DLL IMDDimension {
public:
  virtual ~IMDDimension() = default;
 
  virtual std::string getName() const = 0;
 
  virtual const Geometry::MDFrame &getMDFrame() const = 0;
 
  virtual const Kernel::UnitLabel getUnits() const = 0;
 
  virtual const Kernel::MDUnit &getMDUnits() const = 0;
 
  virtual const std::string &getDimensionId() const = 0;
 
  virtual coord_t getMinimum() const = 0;
 
  virtual coord_t getMaximum() const = 0;
 
  virtual size_t getNBins() const = 0;
 
  virtual size_t getNBoundaries() const = 0;
 
  virtual std::string toXMLString() const = 0;
 
  virtual void setRange(size_t nBins, coord_t min, coord_t max) = 0;
 
  virtual coord_t getX(size_t ind) const = 0;
 
  virtual coord_t getBinWidth() const { return (getMaximum() - getMinimum()) / static_cast<coord_t>(getNBins()); }
 
  virtual bool getIsIntegrated() const { return getNBins() == 1; }
 
  bool operator==(const IMDDimension &) const { throw std::runtime_error("Not Implemented."); }
  bool operator!=(const IMDDimension &) const { throw std::runtime_error("Not Implemented."); }
};
 
using IMDDimension_sptr = std::shared_ptr<IMDDimension>;
using IMDDimension_const_sptr = std::shared_ptr<const IMDDimension>;
using VecIMDDimension_const_sptr = std::vector<IMDDimension_const_sptr>;
using VecIMDDimension_sptr = std::vector<IMDDimension_sptr>;
} // namespace Geometry
} // namespace Mantid