MDGeometryXMLBuilder.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
 
#include "MantidGeometry/DllConfig.h"
#include "MantidGeometry/MDGeometry/IMDDimension.h"
#include <algorithm>
#include <string>
#include <vector>
 
namespace Mantid {
namespace Geometry {
 
template <typename CheckDimensionPolicy> class MANTID_GEOMETRY_DLL MDGeometryBuilderXML {
 
public:
  MDGeometryBuilderXML();
 
  ~MDGeometryBuilderXML();
 
  bool addOrdinaryDimension(IMDDimension_const_sptr dimensionToAdd) const;
 
  void addManyOrdinaryDimensions(const VecIMDDimension_sptr &manyDims) const;
 
  bool addXDimension(const IMDDimension_const_sptr &dimension) const;
 
  bool addYDimension(const IMDDimension_const_sptr &dimension) const;
 
  bool addZDimension(const IMDDimension_const_sptr &dimension) const;
 
  bool addTDimension(const IMDDimension_const_sptr &dimension) const;
 
  MDGeometryBuilderXML(const MDGeometryBuilderXML &);
 
  MDGeometryBuilderXML &operator=(const MDGeometryBuilderXML &);
 
  const std::string &create() const;
 
  bool hasXDimension() const;
 
  bool hasYDimension() const;
 
  bool hasZDimension() const;
 
  bool hasTDimension() const;
 
  bool hasIntegratedTDimension() const;
 
private:
  using DimensionContainerType = std::vector<IMDDimension_const_sptr>;
 
  mutable DimensionContainerType m_vecDimensions;
 
  mutable IMDDimension_const_sptr m_spXDimension;
 
  mutable IMDDimension_const_sptr m_spYDimension;
 
  mutable IMDDimension_const_sptr m_spZDimension;
 
  mutable IMDDimension_const_sptr m_spTDimension;
 
  void applyPolicyChecking(const IMDDimension &dimensionToAdd) const;
 
  mutable bool m_changed;
 
  mutable std::string m_lastResult;
};
 
/*
 @class StrictDimensionPolicy
 @brief Unary operator that throws if the dimension provided is integrated.
 @author Owen Arnold
 @date May 2011
 @version 1.0
*/
struct MANTID_GEOMETRY_DLL StrictDimensionPolicy {
public:
  StrictDimensionPolicy() {}
  void operator()(const IMDDimension &item) {
    if (true == item.getIsIntegrated()) {
      std::string message = "StrictDimensionPolicy bans the use of integrated "
                            "IMDDimensions mapped to x, y, z or t in a "
                            "IMDWorkspace."
                            "Attempted to do so with IMDDimension: " +
                            item.getDimensionId();
      throw std::invalid_argument(message);
    }
  }
};
 
/*
 @class NoDimensionPolicy
 @brief Unary operator that has no effect.
 @author Owen Arnold
 @date May 2011
*/
struct MANTID_GEOMETRY_DLL NoDimensionPolicy {
  void operator()(const IMDDimension &) {
    // Do nothing.
  }
};
} // namespace Geometry
} // namespace Mantid