BoolFilteredTimeSeriesProperty

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

bases: mantid.kernel.BoolTimeSeriesProperty

class mantid.kernel.BoolFilteredTimeSeriesProperty((object)self, (BoolTimeSeriesProperty)source, (BoolTimeSeriesProperty)filter, (bool)transferOwner)
EMPTY_DBL = 8.9884656743115785e+307
EMPTY_INT = 2147483647
EMPTY_LONG = 9223372036854775807
__init__((object)self, (BoolTimeSeriesProperty)source, (BoolTimeSeriesProperty)filter, (bool)transferOwner) → None :

Constructor

addValue((BoolTimeSeriesProperty)self, (DateAndTime)time, (bool)value) → None

addValue( (BoolTimeSeriesProperty)self, (str)time, (bool)value) -> None

allowedValues

A list of allowed values

clear((BoolTimeSeriesProperty)self) → None
direction

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

documentation

The property’s doc string

firstTime((BoolTimeSeriesProperty)self) → DateAndTime
firstValue((BoolTimeSeriesProperty)self) → bool
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((BoolTimeSeriesProperty)self) → 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((BoolTimeSeriesProperty)self) → DateAndTime
lastValue((BoolTimeSeriesProperty)self) → bool
name

The name of the property

nthTime((BoolTimeSeriesProperty)self, (int)index) → DateAndTime
nthValue((BoolTimeSeriesProperty)self, (int)index) → bool
settings

Return the object managing this property’s settings

size((BoolTimeSeriesProperty)self) → int
timeAverageValue((BoolTimeSeriesProperty)self) → float
times
type

Returns a string identifier for the type

unfiltered((BoolFilteredTimeSeriesProperty)self) → BoolTimeSeriesProperty :

Returns a time series containing the unfiltered data

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

valueAsString((BoolTimeSeriesProperty)self) → str