Axis.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2008 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 "MantidGeometry/IDTypes.h"
 
#include <memory>
#include <string>
 
namespace Mantid {
namespace Kernel {
class Unit;
}
namespace API {
//----------------------------------------------------------------------
// Forward declaration
//----------------------------------------------------------------------
class MatrixWorkspace;
 
class MANTID_API_DLL Axis {
public:
  Axis();
  virtual ~Axis() = default;
 
  virtual Axis *clone(const MatrixWorkspace *const parentWorkspace) = 0;
  virtual Axis *clone(const std::size_t length, const MatrixWorkspace *const parentWorkspace) = 0;
 
  const std::string &title() const;
  std::string &title();
 
  const std::shared_ptr<Kernel::Unit> &unit() const;
  std::shared_ptr<Kernel::Unit> &unit();
 
  virtual const std::shared_ptr<Kernel::Unit> &setUnit(const std::string &unitName);
 
  virtual bool isSpectra() const { return false; }
  virtual bool isNumeric() const { return false; }
  virtual bool isText() const { return false; }
 
  virtual double operator()(const std::size_t &index, const std::size_t &verticalIndex = 0) const = 0;
  double getValue(const std::size_t &index, const std::size_t &verticalIndex = 0) const;
  virtual double getMin() const = 0;
  virtual double getMax() const = 0;
  virtual void setValue(const std::size_t &index, const double &value) = 0;
  virtual size_t indexOfValue(const double value) const = 0;
 
  virtual specnum_t spectraNo(const std::size_t &index) const;
 
  virtual std::size_t length() const = 0;
 
  virtual bool operator==(const Axis &) const = 0;
 
  virtual std::string label(const std::size_t &index) const = 0;
 
protected:
  Axis(const Axis &) = default;
  Axis &operator=(const Axis &) = default;
 
private:
  std::string m_title;
  std::shared_ptr<Kernel::Unit> m_unit;
};
 
} // namespace API
} // namespace Mantid