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 More...

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

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

	MaskedProperty (const MaskedProperty &)=default

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

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

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. More...

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

std::string	getDefault () const override
	Get the default value for the property which is the value the property was initialised with. More...

IValidator_sptr	getValidator () const

bool	isDefault () const override
	Overriden function that returns if property has the same value that it was initialised with, if applicable. More...

bool	isMultipleSelectionAllowed () override
	Is Multiple Selection Allowed. More...

std::string	isValid () const override
	Overridden function that checks whether the property, if not overriden returns "". More...

virtual	operator const TYPE & () const

bool	operator!= (const PropertyWithValue< TYPE > &rhs) const

virtual const TYPE &	operator() () const

PropertyWithValue &	operator+= (Property const *right) override
	Add to this. More...

PropertyWithValue &	operator= (const PropertyWithValue &right)

virtual PropertyWithValue &	operator= (const TYPE &value)

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

	PropertyWithValue (const PropertyWithValue< TYPE > &right)

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

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

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

virtual void	replaceValidator (IValidator_sptr newValidator)

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 the value of the property via a DataItem pointer. More...

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

std::string	setValueFromJson (const Json::Value &value) override
	Set the value of the property via a Json object. More...

int	size () const override
	Return the size of this property. More...

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

Json::Value	valueAsJson () const override
	Returns the value of the property as a Json::Value. More...

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

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

bool	autoTrim () const
	Returns if the property is set to automatically trim string unput values of whitespace. More...

void	clearSettings ()
	Deletes the PropertySettings object contained. More...

virtual Property *	clone () const =0
	'Virtual copy constructor' More...

virtual const PropertyHistory	createHistory () const
	Create a PropertyHistory object representing the current state of the Property. More...

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

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

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

virtual void	filterByTime (const Types::Core::DateAndTime &start, const Types::Core::DateAndTime &stop)
	Filter out a property by time. More...

virtual std::string	getDefault () const =0
	Get the default value for the property which is the value the property was initialised with. More...

const std::string &	getGroup ()

virtual size_t	getMemorySize () const

IPropertySettings *	getSettings ()

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

virtual bool	isDefault () const =0
	Overriden function that returns if property has the same value that it was initialised with, if applicable. More...

virtual bool	isMultipleSelectionAllowed ()
	Is Multiple Selection Allowed. More...

virtual std::string	isValid () const
	Overridden function that checks whether the property, if not overriden returns "". More...

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

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

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

virtual Property &	operator+= (Property const *rhs)=0
	Add to this. More...

bool	remember () const
	Whether to save input values. More...

virtual void	saveProperty (::NeXus::File *)

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

virtual std::string	setDataItem (const std::shared_ptr< DataItem > &)=0
	Set the value of the property via a DataItem pointer. More...

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

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

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

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

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

virtual std::string	setValue (const std::string &)=0
	Set the value of the property via a string. More...

virtual std::string	setValueFromJson (const Json::Value &)=0
	Set the value of the property via a Json object. More...

virtual std::string	setValueFromProperty (const Property &right)=0
	Set the value of the property via a reference to another property. More...

virtual int	size () const
	Return the size of this property. More...

virtual void	splitByTime (std::vector< SplittingInterval > &splitter, std::vector< Property * > outputs, bool isProtonCharge=true) const
	Split a property by time. More...

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

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

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

virtual std::string	value () const =0
	Returns the value of the property as a string. More...

virtual Json::Value	valueAsJson () const =0
	Returns the value of the property as a Json::Value. More...

virtual std::string	valueAsPrettyStr (const size_t maxLength=0, const bool collapseLists=true) const
	Returns the value of the property as a pretty printed string. More...

virtual	~Property ()
	Virtual destructor. More...

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

Private Attributes
TYPE	m_maskedValue
	the masked value More...

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

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

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

TYPE	m_value
	The value of the property. More...

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

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

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

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.

◆ doMasking()

template<typename TYPE >

void Mantid::Kernel::MaskedProperty< TYPE >::doMasking

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

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