TaurusAttribute

Inheritance diagram of TaurusAttribute
class TaurusAttribute(name='', parent=None, **kwargs)[source]

Bases: taurus.core.taurusmodel.TaurusModel

DftTimeToLive = 10000
activatePolling(period, unsubscribe_evts=False, force=False)[source]

activate polling for attribute.

Parameters

period (int) – polling period (in miliseconds)

property alarms
areStrValuesEqual(v1, v2)[source]
classmethod buildModelName(parent_model, relative_name)[source]

build an ‘absolute’ model name from the parent model and the ‘relative’ name. - If parent_model is a TaurusDevice, the return is a composition of the database model name and its device name - If parent_model is a TaurusAttribute, the relative name is ignored and the parent name is returned

Note: This is a basic implementation. You may need to reimplement this

for a specific scheme if it supports “useParentModel”.

changePollingPeriod(period)[source]

change polling period to period miliseconds

cleanUp()[source]

The cleanUp. Default implementation does nothing Overwrite when necessary

deactivatePolling(maintain_enabled=False)[source]

unregister attribute from polling

decode(attr_value)[source]
defaultFragmentName = 'rvalue'
property description
disablePolling()[source]

Disable polling and if polling is active also deactivate it. See isPollingEnabled() for clarification of what enabled polling means.

enablePolling(force=False)[source]

Enable polling. See isPollingEnabled() for clarification of what enabled polling means.

Parameters

force (bool) – True also activates polling (see: activatePolling())

encode(value)[source]
getAlarms(cache=True)[source]
getDataFormat(cache=True)[source]
getDisplayDescrObj(cache=True)[source]

A brief description of the model. Can be used as tooltip, for example

getDisplayDescription(cache=True)[source]
getLabel(cache=True)[source]
getMaxAlarm(cache=True)[source]
getMaxRange(cache=True)[source]
getMaxWarning(cache=True)[source]
getMinAlarm(cache=True)[source]
getMinRange(cache=True)[source]
getMinWarning(cache=True)[source]
classmethod getNameValidator()[source]
getPollingPeriod()[source]

returns the polling period

getRange(cache=True)[source]
classmethod getTaurusElementType()[source]
getType(cache=True)[source]
getValueObj(cache=True)[source]
getWarnings(cache=True)[source]
hasEvents()[source]
isBoolean(cache=True)[source]
isNumeric()[source]
isPolled()[source]
isPollingActive()[source]

Indicate whether polling is active. Active polling means that a periodic timer poll the attribute. By default the attribute creation does not activate polling.

Return type

bool

Returns

whether polling is active

See

activatePolling(), disablePolling()

isPollingEnabled()[source]

Indicate whether polling was activated/deactivated by user. Enabled polling does not mean that it is active - periodically poll the attribute. By default the attribute creation enables polling.

Return type

bool

Returns

whether polling is enabled

See

enablePolling(), disablePolling()

isPollingForced()[source]
isState(**kwargs)

Deprecated since version >4.0.1: Use .type==DataType.DevState instead

isUsingEvents()[source]
isWritable(cache=True)[source]
property label
poll()[source]
property quality
property range
read(cache=True)[source]
property rvalue
setAlarms(*limits)[source]
setLabel(lbl)[source]
setRange(*limits)[source]
setWarnings(*limits)[source]
property time
property warnings
write(value, with_read=True)[source]
property wvalue