ParameterInfo.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2026 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/Instrument/Parameter.h"
#include "MantidKernel/CaseInsensitiveMap.h"
 
#include <cstddef>
#include <map>
#include <memory>
#include <set>
#include <string>
#include <utility>
 
namespace Mantid {
namespace Geometry {
 
class ComponentInfo;
class XMLInstrumentParameter;
 
class MANTID_GEOMETRY_DLL ParameterInfo {
public:
  using ComponentParameters =
      std::multimap<std::string, std::shared_ptr<Parameter>, Kernel::CaseInsensitiveStringComparator>;
 
  using LogfileParameters = std::map<std::pair<size_t, std::string>, std::shared_ptr<const XMLInstrumentParameter>>;
 
  void add(size_t const componentIndex, std::shared_ptr<Parameter> const &parameter);
 
  bool addFittingParameter(size_t const componentIndex, std::shared_ptr<Parameter> const &parameter,
                           std::string const &fittingFunction);
 
  void insert(size_t const componentIndex, std::shared_ptr<Parameter> const &parameter);
 
  bool contains(size_t const componentIndex, std::string const &name, std::string const &type = "") const;
 
  std::shared_ptr<Parameter> get(size_t const componentIndex, std::string const &name,
                                 std::string const &type = "") const;
 
  std::shared_ptr<Parameter> getByType(size_t const componentIndex, std::string const &type) const;
 
  std::shared_ptr<Parameter> getRecursive(ComponentInfo const &componentInfo, size_t const componentIndex,
                                          std::string const &name, std::string const &type = "") const;
 
  std::shared_ptr<Parameter> getRecursiveByType(ComponentInfo const &componentInfo, size_t const componentIndex,
                                                std::string const &type) const;
 
  std::shared_ptr<Parameter> getRecursiveFittingParameter(ComponentInfo const &componentInfo,
                                                          size_t const componentIndex, std::string const &name,
                                                          std::string const &fittingFunction) const;
 
  std::set<std::string> names(size_t const componentIndex) const;
 
  ComponentParameters const &parameters(size_t const componentIndex) const;
 
  void clearParametersByName(std::string const &name);
 
  void clearParametersByName(size_t const componentIndex, std::string const &name);
 
  void clear();
 
  void addLogfileParameter(size_t const componentIndex, std::string const &cacheKey,
                           std::shared_ptr<const XMLInstrumentParameter> const &parameter);
 
  LogfileParameters const &logfileParameters() const;
 
  bool empty() const;
 
  size_t size() const;
 
  size_t getMemorySize() const;
 
  auto begin() const { return m_store.begin(); }
  auto end() const { return m_store.end(); }
 
private:
  std::map<size_t, ComponentParameters> m_store;
  LogfileParameters m_logfileParameters;
};
 
} // namespace Geometry
} // namespace Mantid