MaskedProperty.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/PropertyWithValue.h"
#include <string>
 
namespace Mantid {
namespace Kernel {
template <typename TYPE = std::string> class MaskedProperty : public Kernel::PropertyWithValue<TYPE> {
public:
  MaskedProperty(std::string name, TYPE defaultvalue, IValidator_sptr validator = IValidator_sptr(new NullValidator),
                 const unsigned int direction = Direction::Input);
  MaskedProperty(std::string name, TYPE defaultvalue, const unsigned int direction);
 
  MaskedProperty(const MaskedProperty &) = default;
  // Unhide the PropertyWithValue assignment operator
  using Kernel::PropertyWithValue<TYPE>::operator=;
 
  MaskedProperty *clone() const override;
 
  const Kernel::PropertyHistory createHistory() const override;
 
  TYPE getMaskedValue() const;
 
private:
  void doMasking() const;
 
  mutable TYPE m_maskedValue; 
};
} // namespace Kernel
} // namespace Mantid