StringArrayProperty¶

This a python binding to the C++ class Mantid::Kernel::ArrayProperty.

bases: mantid.kernel.VectorStringPropertyWithValue

class mantid.kernel.StringArrayProperty((object)arg1, (str)name[, (int)direction=mantid.kernel._kernel.Direction.Input])¶

EMPTY_DBL = 8.9884656743115785e+307¶

EMPTY_INT = 2147483647¶

EMPTY_LONG = 9223372036854775807¶

__init__((object)arg1, (str)name[, (int)direction=mantid.kernel._kernel.Direction.Input]) → None :¶

Construct an ArrayProperty of typestd::string

__init__( (object)arg1, (str)name, (IValidator)validator [, (int)direction=mantid.kernel._kernel.Direction.Input]) -> None :

Construct an ArrayProperty of typestd::stringwith a validator

__init__( (object)arg1, (str)name, (str)values [, (IValidator)validator=<mantid.kernel._kernel.IValidator object at 0x7f83afc2f140> [, (int)direction=mantid.kernel._kernel.Direction.Input]]) -> None :

Construct an ArrayProperty of typestd::stringwith a validator giving the values as a string

__init__( (object)arg1, (str)name, (list)values [, (IValidator)validator=<mantid.kernel._kernel.IValidator object at 0x7f83afc2f0c8> [, (int)direction=mantid.kernel._kernel.Direction.Input]]) -> object

__init__( (object)arg1, (str)name, (object)values [, (IValidator)validator=<mantid.kernel._kernel.IValidator object at 0x7f83afc2f050> [, (int)direction=mantid.kernel._kernel.Direction.Input]]) -> object

allowedValues¶

A list of allowed values

direction¶

Input, Output, InOut or Unknown. See the Direction class

documentation¶

The property’s doc string

getDefault¶

Get the default value as a string

getGroup¶

Return the ‘group’ of the property, that is, the header in the algorithm’s list of properties.

isDefault¶

Is the property set at the default value

isValid¶

An empty string if the property is valid, otherwise it contains an error message.

name¶

The name of the property

settings¶

Return the object managing this property’s settings

type¶

Returns a string identifier for the type

units¶

The units attached to this property

value¶

valueAsStr¶

The value of the property as a string. For some property types, e.g. Workspaces, it is useful to be able to refer to the string value directly