A property class for masking the properties. More...

#include <MaskedProperty.h>

Inheritance diagram for Mantid::Kernel::MaskedProperty< TYPE >:

Public Member Functions
MaskedProperty *	clone () const override
	"virtual" copy constructor

const Kernel::PropertyHistory	createHistory () const override
	Mask out the out the value in the history.

TYPE	getMaskedValue () const
	This method returns the masked property value.

	MaskedProperty (const MaskedProperty &)=default

	MaskedProperty (std::string name, TYPE defaultvalue, const unsigned int direction)
	Constructor with a validator without validation.

	MaskedProperty (std::string name, TYPE defaultvalue, IValidator_sptr validator=IValidator_sptr(new NullValidator), const unsigned int direction=Direction::Input)
	Constructor with a validator.

Public Member Functions inherited from Mantid::Kernel::PropertyWithValue< TYPE >
std::vector< std::string >	allowedValues () const override
	Returns the set of valid values for this property, if such a set exists.

PropertyWithValue< TYPE > *	clone () const override
	'Virtual copy constructor'

std::string	getDefault () const override
	Get the value the property was initialised with -its default value.

IValidator_sptr	getValidator () const
	Returns the validator as a constant variable so it cannot be changed.

bool	isDefault () const override
	Indicates if the property's value is the same as it was when it was set N.B.

bool	isMultipleSelectionAllowed () override
	Returns the set of valid values for this property, if such a set exists.

std::string	isValid () const override
	Check the value chosen for the property is OK, unless overidden it just calls the validator's isValid() N.B.

virtual	operator const TYPE & () const
	Allows you to get the value of the property simply by typing its name.

bool	operator!= (const PropertyWithValue< TYPE > &rhs) const
	Deep comparison (not equal).

virtual const TYPE &	operator() () const
	Allows you to get the value of the property via an expression like myProperty()

PropertyWithValue &	operator+= (Property const *right) override
	Add the value of another property.

PropertyWithValue &	operator= (const PropertyWithValue &right)
	Copy assignment operator assigns only the value and the validator not the name, default (initial) value, etc.

virtual PropertyWithValue &	operator= (const TYPE &value)
	Assignment operator.

bool	operator== (const PropertyWithValue< TYPE > &rhs) const
	Deep comparison.

	PropertyWithValue ()=delete

	PropertyWithValue (const PropertyWithValue< TYPE > &right)
	Copy constructor Note the default value of the copied object is the initial value of original.

	PropertyWithValue (const std::string &name, const TYPE &defaultValue, const std::string &defaultValueStr, IValidator_sptr validator, const unsigned int direction)
	Constructor.

	PropertyWithValue (std::string name, TYPE defaultValue, const unsigned int direction)
	Constructor.

	PropertyWithValue (std::string name, TYPE defaultValue, IValidator_sptr validator=IValidator_sptr(new NullValidator), const unsigned int direction=Direction::Input)
	Constructor.

virtual void	replaceValidator (IValidator_sptr newValidator)
	Replace the current validator with the given one.

MANTID_KERNEL_DLL void	saveProperty (Nexus::File *file)

MANTID_KERNEL_DLL void	saveProperty (Nexus::File *file)

MANTID_KERNEL_DLL void	saveProperty (Nexus::File *file)

MANTID_KERNEL_DLL void	saveProperty (Nexus::File *file)

MANTID_KERNEL_DLL void	saveProperty (Nexus::File *file)

MANTID_KERNEL_DLL void	saveProperty (Nexus::File *file)

MANTID_KERNEL_DLL void	saveProperty (Nexus::File *file)

MANTID_KERNEL_DLL void	saveProperty (Nexus::File *file)

MANTID_KERNEL_DLL void	saveProperty (Nexus::File *file)

void	saveProperty (Nexus::File *file) override

std::string	setDataItem (const std::shared_ptr< DataItem > &data) override
	Set a property value via a DataItem.

std::string	setValue (const std::string &value) override
	Set the value of the property from a string representation.

std::string	setValueFromJson (const Json::Value &value) override
	Set the value of the property from a Json representation.

int	size () const override
	Get the size of the property.

std::string	value () const override
	Get the value of the property as a string.

Json::Value	valueAsJson () const override
	Attempt to construct a Json::Value object from the plain value.

std::string	valueAsPrettyStr (const size_t maxLength=0, const bool collapseLists=true) const override
	Get the value of the property as a string.

Public Member Functions inherited from Mantid::Kernel::Property
bool	autoTrim () const
	Returns if the property is set to automatically trim string unput values of whitespace.

void	clearSettings ()
	Deletes the PropertySettings object contained.

void	createTemporaryValue ()
	Create a temporary value for this property.

unsigned int	direction () const
	returns the direction of the property

bool	disableReplaceWSButton () const
	Returns if the property is set to disable the creation of the "Replace Workspace" button.

const std::string &	documentation () const
	Get the property's documentation string.

const std::string &	getGroup ()

virtual size_t	getMemorySize () const

IPropertySettings *	getSettings ()

const IPropertySettings *	getSettings () const

bool	hasTemporaryValue () const
	Property is using a temporary value for this property.

bool	isDynamicDefault () const
	Returns a flag indicating that the property's value has been set programmatically, for example, if the property has a default value which depends on the value of an upstream property.

virtual bool	isValueSerializable () const
	Whether the string returned by value() can be used for serialization.

virtual Property &	merge (Property *)
	Just returns the property (*this) unless overridden.

const std::string &	name () const
	Get the property's name.

bool	remember () const
	Whether to save input values.

void	setAutoTrim (const bool &setting)
	Sets if the property is set to automatically trim string unput values of whitespace.

void	setDisableReplaceWSButton (const bool &disable)
	Sets the property to disable the creation of the "Replace Workspace" button.

void	setDocumentation (const std::string &documentation)
	Sets the user level description of the property.

void	setGroup (const std::string &group)
	Set the group this property belongs to.

void	setIsDynamicDefault (const bool &flag)
	Set or clear the flag indicating whether or not the property's value has been set programmatically.

void	setName (const std::string &name)
	Set the property's name.

void	setRemember (bool)
	Set wheter to remeber this property input.

void	setSettings (std::unique_ptr< IPropertySettings > settings)
	Set the PropertySettings object.

virtual void	setUnits (const std::string &unit)
	Sets the units of the property, as a string.

const std::string	type () const
	Returns the type of the property as a string.

const std::type_info *	type_info () const
	Get the property type_info.

virtual const std::string &	units () const
	Returns the units of the property, if any, as a string.

virtual	~Property ()
	Virtual destructor.

Private Member Functions
void	doMasking () const
	Perform the actual masking.

Private Attributes
TYPE	m_maskedValue
	the masked value

Additional Inherited Members
Protected Member Functions inherited from Mantid::Kernel::Property
	Property (const Property &right)
	Copy constructor.

	Property (std::string name, const std::type_info &type, const unsigned int &direction=Direction::Input)
	Constructor.

Protected Attributes inherited from Mantid::Kernel::PropertyWithValue< TYPE >
TYPE	m_initialValue
	the property's default value which is also its initial value

TYPE	m_value
	The value of the property.

Protected Attributes inherited from Mantid::Kernel::Property
std::string	m_name
	The name of the property.

Detailed Description

template<typename TYPE = std::string>
class Mantid::Kernel::MaskedProperty< TYPE >

A property class for masking the properties.

It inherits from PropertyWithValue. This class masks the properties and useful when the property value is not to be displayed in the user interface widgets like algorithm history display, log window etc and log file .The masked property will be displayed. This class is specialised for string and masks the property value with charcater "*"

Definition at line 27 of file MaskedProperty.h.

Constructor & Destructor Documentation

◆ MaskedProperty() [1/3]

template<typename TYPE >

Mantid::Kernel::MaskedProperty< TYPE >::MaskedProperty	(	std::string	name,
		TYPE	defaultvalue,
		IValidator_sptr	validator = `IValidator_sptr(new NullValidator)`,
		const unsigned int	direction = `Direction::Input`
	)

Constructor with a validator.

Constructor for Maskedproperty class.

Parameters

name	:: name of the property
defaultvalue	:: defaultvalue of the property
validator	:: property validator
direction	:: Whether this is a Direction::Input, Direction::Output or Direction::InOut (Input & Output) property

Definition at line 24 of file MaskedProperty.cpp.

References Mantid::Kernel::Property::setRemember().

◆ MaskedProperty() [2/3]

template<typename TYPE >

Mantid::Kernel::MaskedProperty< TYPE >::MaskedProperty	(	std::string	name,
		TYPE	defaultvalue,
		const unsigned int	direction
	)

Constructor with a validator without validation.

Constructor for Maskedproperty class.

Parameters

name	:: name of the property
defaultvalue	:: defaultvalue of the property
direction	:: Whether this is a Direction::Input, Direction::Output or Direction::InOut (Input & Output) property

Definition at line 38 of file MaskedProperty.cpp.

References Mantid::Kernel::Property::setRemember().

◆ MaskedProperty() [3/3]

template<typename TYPE = std::string>

Mantid::Kernel::MaskedProperty< TYPE >::MaskedProperty ( const MaskedProperty< TYPE > & )

default

Member Function Documentation

◆ clone()

template<typename TYPE >

MaskedProperty< TYPE > * Mantid::Kernel::MaskedProperty< TYPE >::clone ( ) const

overridevirtual

"virtual" copy constructor

Virtual copy.

Implements Mantid::Kernel::Property.

Definition at line 46 of file MaskedProperty.cpp.

◆ createHistory()

template<typename TYPE >

const Kernel::PropertyHistory Mantid::Kernel::MaskedProperty< TYPE >::createHistory ( ) const

overridevirtual

Mask out the out the value in the history.

Returns: A new PropertyHistory object with the value masked out

Reimplemented from Mantid::Kernel::Property.

Definition at line 53 of file MaskedProperty.cpp.

References name.

◆ doMasking()

template<typename TYPE >

void Mantid::Kernel::MaskedProperty< TYPE >::doMasking ( ) const

private

Perform the actual masking.

This method creates a masked value for this property.

Definition at line 72 of file MaskedProperty.cpp.

References value.

◆ getMaskedValue()

template<typename TYPE >

TYPE Mantid::Kernel::MaskedProperty< TYPE >::getMaskedValue ( ) const

This method returns the masked property value.

Definition at line 60 of file MaskedProperty.cpp.

Member Data Documentation

◆ m_maskedValue

template<typename TYPE = std::string>

TYPE Mantid::Kernel::MaskedProperty< TYPE >::m_maskedValue

mutableprivate

the masked value

Definition at line 53 of file MaskedProperty.h.

The documentation for this class was generated from the following files:

Framework/Kernel/inc/MantidKernel/MaskedProperty.h
Framework/Kernel/src/MaskedProperty.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MaskedProperty() [1/3]

◆ MaskedProperty() [2/3]

◆ MaskedProperty() [3/3]

Member Function Documentation

◆ clone()

◆ createHistory()

◆ doMasking()

◆ getMaskedValue()

Member Data Documentation

◆ m_maskedValue