WorkspaceSingleValue.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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/HistoWorkspace.h"
#include "MantidDataObjects/Histogram1D.h"
 
namespace Mantid {
 
namespace DataObjects {
class MANTID_DATAOBJECTS_DLL WorkspaceSingleValue : public API::HistoWorkspace {
public:
  const std::string id() const override { return "WorkspaceSingleValue"; }
 
  WorkspaceSingleValue(double value = 0.0, double error = 0.0,
                       const Parallel::StorageMode storageMode = Parallel::StorageMode::Cloned);
 
  std::unique_ptr<WorkspaceSingleValue> clone() const { return std::unique_ptr<WorkspaceSingleValue>(doClone()); }
  std::unique_ptr<WorkspaceSingleValue> cloneEmpty() const {
    return std::unique_ptr<WorkspaceSingleValue>(doCloneEmpty());
  }
  WorkspaceSingleValue &operator=(const WorkspaceSingleValue &other) = delete;
 
  bool isRaggedWorkspace() const override { return false; }
 
  std::size_t size() const override { return 1; }
 
  std::size_t blocksize() const override { return 1; }
  std::size_t getNumberBins(const std::size_t &index) const override {
    UNUSED_ARG(index);
    return 1;
  }
  std::size_t getMaxNumberBins() const override { return 1; }
 
  std::size_t getNumberHistograms() const override { return 1; }
 
  Histogram1D &getSpectrum(const size_t index) override {
    invalidateCommonBinsFlag();
    return getSpectrumWithoutInvalidation(index);
  }
  const Histogram1D &getSpectrum(const size_t /*index*/) const override { return data; }
 
  void generateHistogram(const std::size_t index, const MantidVec &X, MantidVec &Y, MantidVec &E,
                         bool skipError = false) const override;
 
  size_t getNumDims() const override;
 
protected:
  WorkspaceSingleValue(const WorkspaceSingleValue &other);
 
private:
  WorkspaceSingleValue *doClone() const override { return new WorkspaceSingleValue(*this); }
  WorkspaceSingleValue *doCloneEmpty() const override { return new WorkspaceSingleValue(); }
 
  // allocates space in a new workspace - does nothing in this case
  void init(const std::size_t &NVectors, const std::size_t &XLength, const std::size_t &YLength) override;
  void init(const HistogramData::Histogram &histogram) override;
  Histogram1D &getSpectrumWithoutInvalidation(const size_t index) override;
  Histogram1D data{HistogramData::Histogram::XMode::Points, HistogramData::Histogram::YMode::Counts};
};
 
using WorkspaceSingleValue_sptr = std::shared_ptr<WorkspaceSingleValue>;
using WorkspaceSingleValue_const_sptr = std::shared_ptr<const WorkspaceSingleValue>;
 
} // namespace DataObjects
} // namespace Mantid