EnabledWhenProperty.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 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 "MantidKernel/DllConfig.h"
#include "MantidKernel/IPropertySettings.h"
#include <memory>
#include <string>
 
namespace Mantid {
namespace Kernel {
 
// Forward decelerations
class IPropertyManager;
class Property;
 
// Forward deceleration of structs defined at end of header
 
enum ePropertyCriterion { IS_DEFAULT, IS_NOT_DEFAULT, IS_EQUAL_TO, IS_NOT_EQUAL_TO, IS_MORE_OR_EQ };
 
enum eLogicOperator { AND, OR, XOR };
 
class MANTID_KERNEL_DLL EnabledWhenProperty : public IPropertySettings {
public:
  EnabledWhenProperty(const std::string &otherPropName, const ePropertyCriterion when, const std::string &value = "");
 
  EnabledWhenProperty(const EnabledWhenProperty &conditionOne, const EnabledWhenProperty &conditionTwo,
                      eLogicOperator logicOperator);
 
  EnabledWhenProperty(std::shared_ptr<EnabledWhenProperty> &&conditionOne,
                      std::shared_ptr<EnabledWhenProperty> &&conditionTwo, eLogicOperator logicOperator);
 
  EnabledWhenProperty(const EnabledWhenProperty &other);
 
  virtual bool checkComparison(const IPropertyManager *algo) const;
 
  virtual bool checkCriterion(const IPropertyManager *algo) const;
 
  bool isEnabled(const IPropertyManager *algo) const override;
 
  bool isVisible(const IPropertyManager *algo) const override;
 
  std::vector<std::string> dependsOn(const std::string &thisProp) const override;
 
#if 0 // *** DEBUG *** => this seems deprecated?
  void modify_allowed_values(Property *const);
#endif
 
  IPropertySettings *clone() const override;
 
protected:
  struct PropertyDetails {
    const std::string otherPropName;
    const ePropertyCriterion criterion;
    const std::string value;
  };
 
  template <typename WhenPropType> struct ComparisonDetails {
    std::shared_ptr<WhenPropType> conditionOne;
    std::shared_ptr<WhenPropType> conditionTwo;
    const eLogicOperator logicOperator;
  };
 
  EnabledWhenProperty() = default;
 
  std::string getPropertyValue(const IPropertyManager *algo) const;
 
  std::shared_ptr<PropertyDetails> m_propertyDetails = nullptr;
 
private:
  std::shared_ptr<ComparisonDetails<EnabledWhenProperty>> m_comparisonDetails = nullptr;
};
 
} // namespace Kernel
} // namespace Mantid