PropertyHistory.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 "MantidKernel/DllConfig.h"
 
#include <memory>
 
#include <iosfwd>
#include <string>
#include <vector>
 
namespace Mantid {
namespace Kernel {
//----------------------------------------------------------------------
// Forward Declaration
//----------------------------------------------------------------------
class Property;
 
class MANTID_KERNEL_DLL PropertyHistory {
public:
  PropertyHistory(std::string name, std::string value, std::string type, const bool isdefault,
                  const unsigned int direction = 99, const bool pythonVariable = false);
 
  PropertyHistory(Property const *const prop);
  virtual ~PropertyHistory() = default;
  const std::string &name() const { return m_name; };
  const std::string &value() const { return m_value; };
  void setValue(const std::string &value) { m_value = value; };
  const std::string &type() const { return m_type; };
  bool isDefault() const { return m_isDefault; };
  unsigned int direction() const { return m_direction; };
  void printSelf(std::ostream &, const int indent = 0, const size_t maxPropertyLength = 0) const;
  bool isEmptyDefault() const;
  bool pythonVariable() const { return m_pythonVariable; };
 
  bool operator==(const PropertyHistory &other) const {
    return name() == other.name() && value() == other.value() && type() == other.type() &&
           isDefault() == other.isDefault();
  }
 
private:
  std::string m_name;
  std::string m_value;
  std::string m_type;
  bool m_isDefault;
  unsigned int m_direction;
  bool m_pythonVariable;
};
 
// typedefs for property history pointers
using PropertyHistory_sptr = std::shared_ptr<PropertyHistory>;
using PropertyHistory_const_sptr = std::shared_ptr<const PropertyHistory>;
using PropertyHistories = std::vector<PropertyHistory_sptr>;
 
MANTID_KERNEL_DLL std::ostream &operator<<(std::ostream &, const PropertyHistory &);
 
} // namespace Kernel
} // namespace Mantid