LogFilterGenerator.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/MatrixWorkspace_fwd.h"
#include "MantidAPI/Run.h"
#include "MantidKernel/LogFilter.h"
#include "MantidKernel/Property.h"
#include <memory>
 
namespace Mantid {
namespace API {
 
class MANTID_API_DLL LogFilterGenerator {
public:
  enum class FilterType { None, Status, Period, StatusAndPeriod };
 
  LogFilterGenerator(const FilterType filterType, const Mantid::API::MatrixWorkspace_const_sptr &workspace);
 
  LogFilterGenerator(const FilterType filterType, const Mantid::API::Run &run);
 
  std::unique_ptr<Mantid::Kernel::LogFilter> generateFilter(const std::string &logName) const;
 
private:
  void filterByStatus(Mantid::Kernel::LogFilter *filter) const;
  void filterByPeriod(Mantid::Kernel::LogFilter *filter) const;
  Mantid::Kernel::Property *getLogData(const std::string &logName, bool warnIfNotFound = true) const;
  const FilterType m_filterType;
  const Mantid::API::Run m_run;
};
 
} // namespace API
} // namespace Mantid