\(\renewcommand\AA{\unicode{x212B}}\)

Property

This is a Python binding to the C++ class Mantid::Kernel::Property.

class mantid.kernel.Property
EMPTY_DBL = 8.988465674311579e+307
EMPTY_INT = 2147483647
EMPTY_LONG = 9223372036854775807
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

unitsAsBytes

The units attached to this property as a encoded bytes object. It is assumed the caller knows the correct endcoding used.

valueAsPrettyStr((Property)arg1[, (int)maxLength=0[, (bool)collapseLists=True]]) → str :

The value of the property as a formatted string. If maxLength is defined then the output may not contain the full contents of the property. The maxLength and collapseLists arguments do not work for all property types

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