Support for a property that holds an array of values. More...

#include <ArrayProperty.h>

Inheritance diagram for Mantid::Kernel::ArrayProperty< T >:

Public Member Functions
	ArrayProperty (const ArrayProperty &)

	ArrayProperty (const std::string &name, const IValidator_sptr &validator, const unsigned int direction=Direction::Input)
	Constructor Will lead to the property having a default-constructed (i.e.

	ArrayProperty (const std::string &name, const std::string &values, const IValidator_sptr &validator=IValidator_sptr(new NullValidator), const unsigned int direction=Direction::Input)
	Constructor from which you can set the property's values through a string:

	ArrayProperty (const std::string &name, const unsigned int direction=Direction::Input)
	Constructor that's useful for output properties or inputs with an empty default and no validator.

	ArrayProperty (const std::string &name, std::vector< T > vec, const IValidator_sptr &validator=IValidator_sptr(new NullValidator), const unsigned int direction=Direction::Input)
	Constructor.

ArrayProperty< T > *	clone () const override
	'Virtual copy constructor'

std::string	setValue (const std::string &value) override
	Sets the values stored in the ArrayProperty from a string representation.

std::string	value () const override
	Returns the values stored in the ArrayProperty.

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

PropertyWithValue< std::vector< T > > *	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 std::vector< T > & () const
	Allows you to get the value of the property simply by typing its name.

bool	operator!= (const PropertyWithValue< std::vector< T > > &rhs) const
	Deep comparison (not equal).

virtual const std::vector< T > &	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 std::vector< T > &value)
	Assignment operator.

bool	operator== (const PropertyWithValue< std::vector< T > > &rhs) const
	Deep comparison.

	PropertyWithValue ()=delete

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

	PropertyWithValue (const std::string &name, const std::vector< T > &defaultValue, const std::string &defaultValueStr, IValidator_sptr validator, const unsigned int direction)
	Constructor.

	PropertyWithValue (std::string name, std::vector< T > defaultValue, const unsigned int direction)
	Constructor.

	PropertyWithValue (std::string name, std::vector< T > 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.

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

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	visualStudioC4661Workaround ()

MANTID_KERNEL_DLL void	visualStudioC4661Workaround ()

MANTID_KERNEL_DLL void	visualStudioC4661Workaround ()

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< std::vector< T > >
std::vector< T >	m_initialValue
	the property's default value which is also its initial value

std::vector< T >	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 T>
class Mantid::Kernel::ArrayProperty< T >

Support for a property that holds an array of values.

Implemented as a PropertyWithValue that holds a vector of the desired type. This class is really a convenience class to aid in the declaration of the property - there's no problem directly using a PropertyWithValue of vector type.

Author: Russell Taylor, Tessella Support Services plc

Date: 27/02/2008

Definition at line 28 of file ArrayProperty.h.

Constructor & Destructor Documentation

◆ ArrayProperty() [1/5]

template<typename T >

Mantid::Kernel::ArrayProperty< T >::ArrayProperty	(	const std::string &	name,
		std::vector< T >	vec,
		const IValidator_sptr &	validator = `IValidator_sptr(new NullValidator)`,
		const unsigned int	direction = `Direction::Input`
	)

Constructor.

Parameters

name	:: The name to assign to the property
vec	:: The initial vector of values to assign to the property.
validator	:: The validator to use for this property, if required.
direction	:: The direction (Input/Output/InOut) of this property

Definition at line 22 of file ArrayProperty.cpp.

◆ ArrayProperty() [2/5]

template<typename T >

Mantid::Kernel::ArrayProperty< T >::ArrayProperty	(	const std::string &	name,
		const IValidator_sptr &	validator,
		const unsigned int	direction = `Direction::Input`
	)

Constructor Will lead to the property having a default-constructed (i.e.

empty) vector as its initial (default) value

Parameters

name	:: The name to assign to the property
validator	:: The validator to use for this property, if required
direction	:: The direction (Input/Output/InOut) of this property

Definition at line 35 of file ArrayProperty.cpp.

◆ ArrayProperty() [3/5]

template<typename T >

Mantid::Kernel::ArrayProperty< T >::ArrayProperty	(	const std::string &	name,
		const unsigned int	direction = `Direction::Input`
	)

Constructor that's useful for output properties or inputs with an empty default and no validator.

Will lead to the property having a default-constructed (i.e. empty) vector as its initial (default) value and no validator

Parameters

name	:: The name to assign to the property
direction	:: The direction (Input/Output/InOut) of this property

Definition at line 46 of file ArrayProperty.cpp.

◆ ArrayProperty() [4/5]

template<typename T >

Mantid::Kernel::ArrayProperty< T >::ArrayProperty	(	const std::string &	name,
		const std::string &	values,
		const IValidator_sptr &	validator = `IValidator_sptr(new NullValidator)`,
		const unsigned int	direction = `Direction::Input`
	)

Constructor from which you can set the property's values through a string:

Inherits from the constructor of PropertyWithValue specifically made to handle a list of numeric values in a string format so that initial value is set correctly.

Parameters

name	:: The name to assign to the property
values	:: A comma-separated string containing the values to store in the property
validator	:: The validator to use for this property, if required
direction	:: The direction (Input/Output/InOut) of this property

Exceptions

std::invalid_argument if the string passed is not compatible with the array type

Definition at line 65 of file ArrayProperty.cpp.

◆ ArrayProperty() [5/5]

template<typename T >

Mantid::Kernel::ArrayProperty< T >::ArrayProperty ( const ArrayProperty< T > & other )

Definition at line 70 of file ArrayProperty.cpp.

Member Function Documentation

◆ clone()

template<typename T >

ArrayProperty< T > * Mantid::Kernel::ArrayProperty< T >::clone ( ) const

overridevirtual

'Virtual copy constructor'

Implements Mantid::Kernel::Property.

Reimplemented in Mantid::API::IndexProperty.

Definition at line 73 of file ArrayProperty.cpp.

◆ setValue()

template<typename T >

std::string Mantid::Kernel::ArrayProperty< T >::setValue ( const std::string & value )

overridevirtual

Sets the values stored in the ArrayProperty from a string representation.

Parameters

value :: The values to assign to the property, given as a comma-separated list

Returns: True if the assignment was successful

Implements Mantid::Kernel::Property.

Definition at line 89 of file ArrayProperty.cpp.

References value.

◆ value()

template<typename T >

std::string Mantid::Kernel::ArrayProperty< T >::value ( ) const

overridevirtual

Returns the values stored in the ArrayProperty.

Returns: The stored values as a comma-separated list

Implements Mantid::Kernel::Property.

Definition at line 78 of file ArrayProperty.cpp.

References value.

◆ visualStudioC4661Workaround() [1/3]

template<typename T >

void Mantid::Kernel::ArrayProperty< T >::visualStudioC4661Workaround ( )

private

Definition at line 95 of file ArrayProperty.cpp.

◆ visualStudioC4661Workaround() [2/3]

MANTID_KERNEL_DLL void Mantid::Kernel::ArrayProperty< int >::visualStudioC4661Workaround ( )

private

◆ visualStudioC4661Workaround() [3/3]

MANTID_KERNEL_DLL void Mantid::Kernel::ArrayProperty< int >::visualStudioC4661Workaround ( )

private

Definition at line 126 of file ArrayProperty.cpp.

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

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

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ArrayProperty() [1/5]

◆ ArrayProperty() [2/5]

◆ ArrayProperty() [3/5]

◆ ArrayProperty() [4/5]

◆ ArrayProperty() [5/5]

Member Function Documentation

◆ clone()

◆ setValue()

◆ value()

◆ visualStudioC4661Workaround() [1/3]

◆ visualStudioC4661Workaround() [2/3]

◆ visualStudioC4661Workaround() [3/3]