IMDEventWorkspace.h

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 +
#pragma once
 
#include "MantidAPI/BoxController.h"
#include "MantidAPI/DllConfig.h"
#include "MantidAPI/ExperimentInfo.h"
#include "MantidAPI/IMDEventWorkspace_fwd.h"
#include "MantidAPI/IMDNode.h"
#include "MantidAPI/IMDWorkspace.h"
#include "MantidAPI/ITableWorkspace_fwd.h"
#include "MantidAPI/MultipleExperimentInfos.h"
#include "MantidAPI/Workspace_fwd.h"
#include "MantidGeometry/MDGeometry/IMDDimension.h"
#include "MantidGeometry/MDGeometry/MDDimensionExtents.h"
#include "MantidGeometry/MDGeometry/MDHistoDimension.h"
#include "MantidKernel/ProgressBase.h"
#include "MantidKernel/ThreadScheduler.h"
 
namespace Mantid {
namespace API {
 
class MANTID_API_DLL IMDEventWorkspace : public API::IMDWorkspace, public API::MultipleExperimentInfos {
public:
  IMDEventWorkspace();
 
  IMDEventWorkspace_uptr clone() const { return IMDEventWorkspace_uptr(doClone()); }
 
  IMDEventWorkspace_uptr cloneEmpty() const { return IMDEventWorkspace_uptr(doCloneEmpty()); }
 
  virtual void initialize() = 0;
  IMDEventWorkspace &operator=(const IMDEventWorkspace &) = delete;
 
  virtual std::vector<Mantid::Geometry::MDDimensionExtents<coord_t>> getMinimumExtents(size_t depth = 2) const = 0;
 
  virtual std::vector<std::string> getBoxControllerStats() const = 0;
 
  virtual Mantid::API::BoxController_sptr getBoxController() = 0;
  virtual Mantid::API::BoxController_const_sptr getBoxController() const = 0;
 
  virtual void getBoxes(std::vector<API::IMDNode *> &boxes, size_t maxDepth, bool leafOnly) = 0;
 
  virtual bool isFileBacked() const = 0;
 
  virtual void setFileBacked() = 0;
 
  virtual void splitBox() = 0;
 
  virtual void refreshCache() = 0;
 
  virtual void setMinRecursionDepth(size_t depth) = 0;
 
  virtual std::string getEventTypeName() const = 0;
  virtual size_t sizeofEvent() const = 0;
 
  virtual void splitAllIfNeeded(Kernel::ThreadScheduler *ts) = 0;
 
  bool fileNeedsUpdating() const;
 
  void setFileNeedsUpdating(bool value);
 
  bool threadSafe() const override;
 
  virtual void setCoordinateSystem(const Mantid::Kernel::SpecialCoordinateSystem coordinateSystem) = 0;
 
  virtual void setDisplayNormalizationHisto(Mantid::API::MDNormalization preferredNormalizationHisto) = 0;
  Mantid::API::MDNormalization displayNormalizationHisto() const override = 0;
 
  virtual void setDisplayNormalization(Mantid::API::MDNormalization preferredNormalization) = 0;
  Mantid::API::MDNormalization displayNormalization() const override = 0;
 
  // Check if this class has an oriented lattice on a sample object
  virtual bool hasOrientedLattice() const override { return MultipleExperimentInfos::hasOrientedLattice(); }
 
  virtual void setBox(API::IMDNode *box) = 0;
 
protected:
  IMDEventWorkspace(const IMDEventWorkspace &) = default;
 
  const std::string toString() const override;
  bool m_fileNeedsUpdating;
 
private:
  IMDEventWorkspace *doClone() const override = 0;
  IMDEventWorkspace *doCloneEmpty() const override = 0;
};
 
} // namespace API
 
} // namespace Mantid