StringFilteredTimeSeriesProperty¶

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

bases: mantid.kernel.StringTimeSeriesProperty

class mantid.kernel.StringFilteredTimeSeriesProperty((object)self, (StringTimeSeriesProperty)source, (BoolTimeSeriesProperty)filter, (bool)transferOwner)¶

EMPTY_DBL = 8.988465674311579e+307¶

EMPTY_INT = 2147483647¶

EMPTY_LONG = 9223372036854775807¶

__init__((object)self, (StringTimeSeriesProperty)source, (BoolTimeSeriesProperty)filter, (bool)transferOwner) → None :¶

Constructor

addValue((StringTimeSeriesProperty)self, (DateAndTime)time, (str)value) → None¶

addValue( (StringTimeSeriesProperty)self, (str)time, (str)value) -> None

addValue( (StringTimeSeriesProperty)self, (object)time, (str)value) -> None

allowedValues¶

A list of allowed values

clear((StringTimeSeriesProperty)self) → None¶

direction¶

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

documentation¶

The property’s doc string

firstTime((StringTimeSeriesProperty)self) → DateAndTime :¶

returns mantid.kernel.DateAndTime

firstValue((StringTimeSeriesProperty)self) → str¶

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.

getStatistics((StringTimeSeriesProperty)self) → TimeSeriesPropertyStatistics :¶

returns mantid.kernel.TimeSeriesPropertyStatistics

isDefault¶

Is the property set at the default value

isValid¶

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

lastTime((StringTimeSeriesProperty)self) → DateAndTime :¶

returns mantid.kernel.DateAndTime

lastValue((StringTimeSeriesProperty)self) → str¶

name¶

The name of the property

nthTime((StringTimeSeriesProperty)self, (int)index) → DateAndTime :¶

returns mantid.kernel.DateAndTime

nthValue((StringTimeSeriesProperty)self, (int)index) → str¶

settings¶

Return the object managing this property’s settings

size((StringTimeSeriesProperty)self) → int¶

timeAverageValue((StringTimeSeriesProperty)self) → float¶

times¶

type¶

Returns a string identifier for the type

unfiltered((StringFilteredTimeSeriesProperty)self) → StringTimeSeriesProperty :¶

Returns a time series containing the unfiltered data

units¶

The units attached to this property

value¶

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

valueAsString((StringTimeSeriesProperty)self) → str¶