WorkspaceHistory.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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/AlgorithmHistory.h"
#include "MantidKernel/EnvironmentHistory.h"
#include <ctime>
#include <set>
 
//-----------------------------------------------------------------------------
// Forward declarations
//-----------------------------------------------------------------------------
namespace NeXus {
class File;
}
 
namespace Mantid {
namespace API {
class IAlgorithm;
class HistoryView;
 
class MANTID_API_DLL WorkspaceHistory {
public:
  WorkspaceHistory();
  virtual ~WorkspaceHistory() = default;
  WorkspaceHistory(const WorkspaceHistory &) = default;
  WorkspaceHistory &operator=(const WorkspaceHistory &) = delete;
  const AlgorithmHistories &getAlgorithmHistories() const;
  const Kernel::EnvironmentHistory &getEnvironmentHistory() const;
  void addHistory(const WorkspaceHistory &otherHistory);
  void addHistory(AlgorithmHistory_sptr algHistory);
  size_t size() const;
  bool empty() const;
  void clearHistory();
  AlgorithmHistory_const_sptr getAlgorithmHistory(const size_t index) const;
  AlgorithmHistory_const_sptr operator[](const size_t index) const;
  bool operator==(const WorkspaceHistory &otherHistory) const;
  std::shared_ptr<IAlgorithm> getAlgorithm(const size_t index) const;
  std::shared_ptr<IAlgorithm> lastAlgorithm() const;
  std::shared_ptr<HistoryView> createView() const;
 
  void printSelf(std::ostream &, const int indent = 0) const;
 
  void saveNexus(::NeXus::File *file) const;
  void loadNexus(::NeXus::File *file);
 
private:
  void loadNestedHistory(::NeXus::File *file,
                         const AlgorithmHistory_sptr &parent = std::shared_ptr<AlgorithmHistory>());
  AlgorithmHistory_sptr parseAlgorithmHistory(const std::string &rawData);
  std::set<int> findHistoryEntries(::NeXus::File *file);
  const Kernel::EnvironmentHistory m_environment;
  Mantid::API::AlgorithmHistories m_algorithms;
};
 
MANTID_API_DLL std::ostream &operator<<(std::ostream &, const WorkspaceHistory &);
 
} // namespace API
} // namespace Mantid