TaurusAttribute
¶
digraph inheritance26a8a4ba34 {
bgcolor=transparent;
rankdir=UD;
ratio=compress;
size="8.0, 12.0";
"Logger" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,tooltip="The taurus logger class. All taurus pertinent classes should inherit"];
"Object" -> "Logger" [arrowsize=0.5,style="setlinewidth(0.5)"];
"Object" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded];
"TaurusAttribute" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded];
"TaurusModel" -> "TaurusAttribute" [arrowsize=0.5,style="setlinewidth(0.5)"];
"TaurusModel" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded];
"Logger" -> "TaurusModel" [arrowsize=0.5,style="setlinewidth(0.5)"];
}
-
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
¶
-
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”.
-
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()
)
-
getDisplayDescrObj
(cache=True)[source]¶ A brief description of the model. Can be used as tooltip, for example
-
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
-
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
-
isState
(**kwargs)¶ Deprecated since version >4.0.1: Use .type==DataType.DevState instead
-
property
label
¶
-
property
quality
¶
-
property
range
¶
-
property
rvalue
¶
-
property
time
¶
-
property
warnings
¶
-
property
wvalue
¶
-