GroupingLoader.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2016 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 "MantidAPI/ITableWorkspace_fwd.h"
#include "MantidGeometry/Instrument.h"
 
namespace Mantid {
namespace API {
 
class MANTID_API_DLL Grouping {
public:
  std::vector<std::string> groupNames;
  std::vector<std::string> groups; // Range strings, e.g. "1-32"
 
  std::vector<std::string> pairNames;
  std::vector<std::pair<size_t, size_t>> pairs; // Pairs of group ids
  std::vector<double> pairAlphas;
 
  std::string description;
  std::string defaultName; // Not storing id because can be either group or pair
 
  Grouping() = default;
 
  ~Grouping();
 
  Grouping(const ITableWorkspace_sptr &table);
 
  ITableWorkspace_sptr toTable() const;
};
 
class MANTID_API_DLL GroupingLoader {
public:
  explicit GroupingLoader(Geometry::Instrument_const_sptr instrument);
  GroupingLoader(Geometry::Instrument_const_sptr instrument, std::string mainFieldDirection);
  virtual ~GroupingLoader();
  std::shared_ptr<Grouping> getGroupingFromIDF() const;
  static void loadGroupingFromXML(const std::string &filename, Grouping &grouping);
  std::shared_ptr<Grouping> getDummyGrouping();
 
private:
  const Geometry::Instrument_const_sptr m_instrument;
  const std::string m_mainFieldDirection;
};
 
} // namespace API
} // namespace Mantid