IPreview.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2020 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/DllConfig.h"
#include "Workspace_fwd.h"
 
#include <string>
 
namespace Mantid {
namespace API {
 
class MANTID_API_DLL IPreview {
public:
  enum class PreviewType { IVIEW = 0, PLOT1D = 1, PLOT2D = 2, SVIEW = 3 };
  virtual ~IPreview() = default;
  virtual PreviewType type() const = 0;
  virtual std::string technique() const = 0;
  virtual std::string facility() const = 0;
  virtual std::string name() const = 0;
  Workspace_sptr view(Workspace_sptr ws) const { return preview(ws); }
 
private:
  virtual Workspace_sptr preview(Workspace_sptr ws) const { return ws; }
};
using IPreview_uptr = std::unique_ptr<IPreview>;
} // namespace API
} // namespace Mantid