AlgorithmHistory.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/DllConfig.h"
#include "MantidKernel/DateAndTime.h"
#include "MantidKernel/PropertyHistory.h"
#include <nexus/NeXusFile.hpp>
 
#include <ctime>
#include <set>
#include <vector>
 
namespace Mantid {
namespace API {
class IAlgorithm;
class Algorithm;
class AlgorithmHistory;
 
// typedefs for algorithm history pointers
using AlgorithmHistory_sptr = std::shared_ptr<AlgorithmHistory>;
using AlgorithmHistory_const_sptr = std::shared_ptr<const AlgorithmHistory>;
using AlgorithmHistories = std::vector<AlgorithmHistory_sptr>;
 
class MANTID_API_DLL AlgorithmHistory {
 
public:
 
  explicit AlgorithmHistory(const Algorithm *const alg,
                            const Types::Core::DateAndTime &start = Types::Core::DateAndTime::getCurrentTime(),
                            const double &duration = -1.0, std::size_t uexeccount = 0);
  AlgorithmHistory &operator=(const AlgorithmHistory &);
  AlgorithmHistory(const AlgorithmHistory &) = default;
  AlgorithmHistory(std::string name, int vers, std::string uuid,
                   const Types::Core::DateAndTime &start = Types::Core::DateAndTime::getCurrentTime(),
                   const double &duration = -1.0, std::size_t uexeccount = 0);
  void addExecutionInfo(const Types::Core::DateAndTime &start, const double &duration);
  void addProperty(const std::string &name, const std::string &value, bool isdefault,
                   const unsigned int &direction = 99);
 
  void addChildHistory(const AlgorithmHistory_sptr &childHist);
  // get functions
  const std::string &name() const { return m_name; }
  const int &version() const { return m_version; }
  double executionDuration() const { return m_executionDuration; }
  Mantid::Types::Core::DateAndTime executionDate() const { return m_executionDate; }
  const std::size_t &execCount() const { return m_execCount; }
  const std::string &uuid() const { return m_uuid; }
  const Mantid::Kernel::PropertyHistories &getProperties() const { return m_properties; }
  const std::string &getPropertyValue(const std::string &name) const;
  const AlgorithmHistories &getChildHistories() const { return m_childHistories; }
  AlgorithmHistory_sptr getChildAlgorithmHistory(const size_t index) const;
  AlgorithmHistory_sptr operator[](const size_t index) const;
  size_t childHistorySize() const;
  void printSelf(std::ostream &, const int indent = 0, const size_t maxPropertyLength = 0) const;
  inline bool operator<(const AlgorithmHistory &other) const { return execCount() < other.execCount(); }
  inline bool operator==(const AlgorithmHistory &other) const {
    return (execCount() == other.execCount() && name() == other.name());
  }
  std::shared_ptr<IAlgorithm> createAlgorithm() const;
  std::shared_ptr<IAlgorithm> getChildAlgorithm(const size_t index) const;
  void saveNexus(::NeXus::File *file, int &algCount) const;
  // Set the execution count
  void setExecCount(std::size_t execCount) { m_execCount = execCount; }
  void fillAlgorithmHistory(const Algorithm *const alg, const Types::Core::DateAndTime &start, const double &duration,
                            std::size_t uexeccount);
  // Allow Algorithm::execute to change the exec count & duration after the
  // algorithm was executed
  friend class Algorithm;
 
private:
  // private constructor
  AlgorithmHistory();
  // Set properties of algorithm
  void setProperties(const Algorithm *const alg);
  std::string m_name;
  int m_version{-1};
  Mantid::Types::Core::DateAndTime m_executionDate;
  double m_executionDuration{-1.0};
  Mantid::Kernel::PropertyHistories m_properties;
  std::size_t m_execCount{0};
  AlgorithmHistories m_childHistories;
  std::string m_uuid;
};
 
MANTID_API_DLL std::ostream &operator<<(std::ostream &, const AlgorithmHistory &);
 
} // namespace API
} // namespace Mantid