Skip to content
Snippets Groups Projects
MDFrame.h 1.92 KiB
Newer Older
#ifndef MANTID_GEOMETRY_MDFRAME_H_
#define MANTID_GEOMETRY_MDFRAME_H_

#include "MantidKernel/System.h"

#include "MantidKernel/MDUnit.h"
#include "MantidKernel/UnitLabel.h"
#include "MantidKernel/SpecialCoordinateSystem.h"

namespace Mantid {
namespace Geometry {

/** MDFrame : The coordinate frame for a dimension, or set of dimensions in a
  multidimensional workspace.

  Copyright © 2015 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
  National Laboratory & European Spallation Source

  This file is part of Mantid.

  Mantid is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 3 of the License, or
  (at your option) any later version.

  Mantid is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.

  File change history is stored at: <https://github.com/mantidproject/mantid>
  Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class DLLExport MDFrame {
public:
  virtual Mantid::Kernel::UnitLabel getUnitLabel() const = 0;
  virtual const Mantid::Kernel::MDUnit &getMDUnit() const = 0;
  virtual bool canConvertTo(const Mantid::Kernel::MDUnit &otherUnit) const = 0;
  virtual std::string name() const = 0;
  virtual Mantid::Kernel::SpecialCoordinateSystem
  equivalientSpecialCoordinateSystem() const = 0;
  virtual MDFrame *clone() const = 0;
  virtual ~MDFrame() {}
typedef std::unique_ptr<MDFrame> MDFrame_uptr;
typedef std::unique_ptr<const MDFrame> MDFrame_const_uptr;

} // namespace Geometry
} // namespace Mantid

#endif /* MANTID_GEOMETRY_MDFRAME_H_ */