IMDEventWorkspace.h

#ifndef IMDEVENTWORKSPACE_H_
#define IMDEVENTWORKSPACE_H_

#include "MantidAPI/BoxController.h"
#include "MantidAPI/DllConfig.h"
#include "MantidAPI/ExperimentInfo.h"
#include "MantidAPI/IMDWorkspace.h"
#include "MantidAPI/ITableWorkspace.h"
#include "MantidAPI/MultipleExperimentInfos.h"
#include "MantidAPI/Workspace.h"
#include "MantidGeometry/MDGeometry/IMDDimension.h"
#include "MantidGeometry/MDGeometry/MDDimensionExtents.h"
#include "MantidGeometry/MDGeometry/MDHistoDimension.h"
#include "MantidKernel/ProgressBase.h"
#include "MantidKernel/ThreadScheduler.h"
#include <boost/shared_ptr.hpp>

namespace Mantid
{
namespace API
{

  /** Abstract base class for multi-dimension event workspaces (MDEventWorkspace).
   * This class will handle as much of the common operations as possible;
   * but since MDEventWorkspace is a templated class, that makes some aspects
   * impossible.
   *
   * @author Janik Zikovsky, SNS
   * @date Dec 3, 2010
   *
   * */
  class MANTID_API_DLL IMDEventWorkspace  : public API::IMDWorkspace, public API::MultipleExperimentInfos
  {
  public:
    IMDEventWorkspace();
    IMDEventWorkspace(const IMDEventWorkspace & other);
    virtual ~IMDEventWorkspace() {}

    /// Perform initialization after dimensions (and others) have been set.
    virtual void initialize() = 0;

    /// Get the minimum extents that hold the data
    virtual std::vector<Mantid::Geometry::MDDimensionExtents> getMinimumExtents(size_t depth=2) = 0;

    /// Returns some information about the box controller, to be displayed in the GUI, for example
    virtual std::vector<std::string> getBoxControllerStats() const = 0;

    virtual Mantid::API::BoxController_sptr getBoxController() = 0;
    virtual Mantid::API::BoxController_const_sptr getBoxController() const = 0;

    /// Helper method that makes a table workspace with some box data
    virtual Mantid::API::ITableWorkspace_sptr makeBoxTable(size_t start, size_t num) = 0;

    /// @return true if the workspace is file-backed
    virtual bool isFileBacked() const = 0;

    /// Set the number of bins in each dimension to something corresponding to the estimated resolution of the finest binning
    virtual void estimateResolution() = 0;

    /// Split the top-level MDBox into a MDGridBox.
    virtual void splitBox() = 0;

    /// Refresh the cache (integrated signal of each box)
    virtual void refreshCache() = 0;

    /// Recurse down to a minimum depth
    virtual void setMinRecursionDepth(size_t depth) = 0;

    /// Return the type of event contained, as a string. MDEvent or MDLeanEvent
    virtual std::string getEventTypeName() const = 0;

    /// Split all boxes that exceed the split threshold.
    virtual void splitAllIfNeeded(Kernel::ThreadScheduler * ts) = 0;

    bool fileNeedsUpdating() const;

    void setFileNeedsUpdating(bool value);


  protected:
    /// Marker set to true when a file-backed workspace needs its back-end file updated (by calling SaveMD(UpdateFileBackEnd=1) )
    bool m_fileNeedsUpdating;

  };

  /// Shared pointer to a generic IMDEventWorkspace
  typedef boost::shared_ptr<IMDEventWorkspace> IMDEventWorkspace_sptr;

  /// Shared pointer to a generic const IMDEventWorkspace
  typedef boost::shared_ptr<const IMDEventWorkspace> IMDEventWorkspace_const_sptr;


}//namespace MDEvents

}//namespace Mantid

#endif /* IMDEVENTWORKSPACE_H_ */