Attribute classes

Attribute classes#

Attr#

class tango.Attr#

check_type(self: tango._tango.Attr) → None#

This method checks data type and throws an exception in case of unsupported data type

Raises:: DevFailed: If the data type is unsupported.

get_assoc(self: tango._tango.Attr) → str#: Get the associated name.

get_cl_name(self: tango._tango.Attr) → str#: Returns the class name.

Added in version 7.2.0.

get_class_properties(self: tango._tango.Attr) → list[tango._tango.AttrProperty]#: Get the class level attribute properties.

get_disp_level(self: tango._tango.Attr) → tango._tango.DispLevel#: Get the attribute display level.

get_format(self: tango._tango.Attr) → tango._tango.AttrDataFormat#: Get the attribute format.

get_memorized(self: tango._tango.Attr) → bool#: Determine if the attribute is memorized or not.

get_memorized_init(self: tango._tango.Attr) → bool#: Determine if the attribute is written at startup from the memorized value if it is memorized.

get_name(self: tango._tango.Attr) → str#: Get the attribute name.

get_polling_period(self: tango._tango.Attr) → int#: Get the polling period (in milliseconds).

get_type(self: tango._tango.Attr) → int#: Get the attribute data type.

get_user_default_properties(self: tango._tango.Attr) → list[tango._tango.AttrProperty]#: Get the user default attribute properties.

get_writable(self: tango._tango.Attr) → tango._tango.AttrWriteType#: Get the attribute write type.

is_alarm_event(self: tango._tango.Attr) → bool#: Check if the alarm event is fired manually (without polling) for this attribute.

Added in version 10.0.0.

is_allowed(self: tango._tango.Attr, device: Tango::DeviceImpl, request_type: tango._tango.AttReqType) → bool#

Returns whether the request_type is allowed for the specified device

Parameters:

device (tango.server.Device) – instance of Device
request_type (AttReqType) – AttReqType.READ_REQ for read request or AttReqType.WRITE_REQ for write request

is_archive_event(self: tango._tango.Attr) → bool#: Check if the archive event is fired manually for this attribute.

is_assoc(self: tango._tango.Attr) → bool#: Determine if it is assoc.

is_change_event(self: tango._tango.Attr) → bool#: Check if the change event is fired manually for this attribute.

is_check_archive_criteria(self: tango._tango.Attr) → bool#: Check if the archive event criteria should be checked when firing the event manually.

is_check_change_criteria(self: tango._tango.Attr) → bool#: Check if the change event criteria should be checked when firing the event manually.

is_data_ready_event(self: tango._tango.Attr) → bool#: Check if the data ready event is fired for this attribute.

Added in version 7.2.0.

read(self: tango._tango.Attr, arg0: Tango::DeviceImpl, arg1: tango._tango.Attribute) → None#

set_alarm_event(self: tango._tango.Attr, implemented: bool, detect: bool) → None#

Set a flag to indicate that the server fires alarm events manually without the polling to be started for the attribute.

If the detect parameter is set to true, the criteria specified for the alarm event (rel_change and abs_change) are verified and the event is only pushed if a least one of them are fulfilled (change in value compared to previous event exceeds a threshold).

If detect is set to false the event is fired without checking!

Parameters:

implemented (bool) – True when the server fires alarm events manually.
detect (bool) – Triggers the verification of the alarm event properties when set to true.

Added in version 10.0.0.

set_archive_event(self: tango._tango.Attr, implemented: bool, detect: bool) → None#

Set a flag to indicate that the server fires archive events manually without the polling to be started for the attribute.

If the detect parameter is set to true, the criteria specified for the archive event (rel_change and abs_change) are verified and the event is only pushed if a least one of them are fulfilled (change in value compared to previous event exceeds a threshold).

If detect is set to false the event is fired without checking!

Parameters:

implemented (bool) – True when the server fires change events manually.
detect (bool) – Triggers the verification of the archive event properties when set to true.

set_change_event(self: tango._tango.Attr, implemented: bool, detect: bool) → None#

Set a flag to indicate that the server fires change events manually without the polling to be started for the attribute.

If the detect parameter is set to true, the criteria specified for the change event (rel_change and abs_change) are verified and the event is only pushed if a least one of them are fulfilled (change in value compared to previous event exceeds a threshold).

If detect is set to false the event is fired without checking!

Parameters:

implemented (bool) – True when the server fires change events manually.
detect (bool) – Triggers the verification of the change event properties when set to true.

set_cl_name(self: tango._tango.Attr, class_name: str) → None#

Sets the class name.

Parameters:: class_name (str) – new class name

Added in version 7.2.0.

set_class_properties(self: tango._tango.Attr, props: collections.abc.Sequence[tango._tango.AttrProperty]) → None#

Set the class level attribute properties.

Parameters:: props (StdAttrPropertyVector) – new class level attribute properties

set_data_ready_event(self: tango._tango.Attr, implemented: bool) → None#

Set a flag to indicate that the server fires data ready events.

Parameters:: implemented (bool) – True when the server fires data ready events

Added in version 7.2.0.

set_default_properties(self: tango._tango.Attr, attr_prop: tango._tango.UserDefaultAttrProp) → None#

Set default attribute properties.

Parameters:: attr_prop (UserDefaultAttrProp) – the user default property class

set_disp_level(self: tango._tango.Attr, disp_level: tango._tango.DispLevel) → None#

Set the attribute display level.

Parameters:: disp_level (DispLevel) – the new display level

set_memorized(self: tango._tango.Attr) → None#

Set the attribute as memorized in database (only for scalar and writable attribute).

By default the setpoint will be written to the attribute during initialisation! Use method set_memorized_init() with False as argument if you don’t want this feature.

set_memorized_init(self: tango._tango.Attr, write_on_init: bool) → None#

Set the initialisation flag for memorized attributes.

true = the setpoint value will be written to the attribute on initialisation
false = only the attribute setpoint is initialised.

No action is taken on the attribute

Parameters:: write_on_init (bool) – if true the setpoint value will be written to the attribute on initialisation

set_polling_period(self: tango._tango.Attr, period_ms: SupportsInt | SupportsIndex) → None#

Set the attribute polling update period.

Parameters:: period_ms (int) – the attribute polling period (in milliseconds)

write(self: tango._tango.Attr, arg0: Tango::DeviceImpl, arg1: tango._tango.WAttribute) → None#

Attribute#

class tango.Attribute#

This class represents a Tango attribute

alarm_event_subscribed(self: tango._tango.Attribute) → bool#: Returns true if there are any subscribers listening for alarm event

Deprecated since version 10.3.0: Use is_event_subscribed() with EventType.ALARM_EVENT instead.

archive_event_subscribed(self: tango._tango.Attribute) → bool#: Returns true if there are any subscribers listening for archive event

Deprecated since version 10.3.0: Use is_event_subscribed() with EventType.ARCHIVE_EVENT instead.

change_event_subscribed(self: tango._tango.Attribute) → bool#: Returns true if there are any subscribers listening for change event

Deprecated since version 10.3.0: Use is_event_subscribed() with EventType.CHANGE_EVENT instead.

check_alarm(self: tango._tango.Attribute) → bool#

Check if the attribute read value is below/above the alarm level.

:raises DevFailed: If no alarm level is defined

fire_alarm_event(*args, **kwargs)#

Overloaded function.

fire_alarm_event(self: tango._tango.Attribute) -> None
fire_alarm_event(self: tango._tango.Attribute, exception: object) -> None

fire_change_event(*args, **kwargs)#

Overloaded function.

fire_change_event(self: tango._tango.Attribute) -> None
fire_change_event(self: tango._tango.Attribute, exception: object) -> None

get_assoc_ind(self: tango._tango.Attribute) → int#: Get index in the main attribute vector of the associated writable attribute.

get_assoc_name(self: tango._tango.Attribute) → str#: Get name of the associated writable attribute.

get_attr_serial_model(self: tango._tango.Attribute) → tango._tango.AttrSerialModel#: Get attribute serialization model.

Added in version 7.1.0.

get_data_format(self: tango._tango.Attribute) → tango._tango.AttrDataFormat#: Get attribute data format.

get_data_size(self: tango._tango.Attribute) → int#: Get attribute data size.

get_data_type(self: tango._tango.Attribute) → int#: Get attribute data type.

get_date(self: tango._tango.Attribute) → tango._tango.TimeVal#: Get the attribute date.

get_disp_level(self: tango._tango.Attribute) → tango._tango.DispLevel#: Returns attribute display level

get_label(self: tango._tango.Attribute) → str#: Get attribute label.

get_max_alarm(self: tango._tango.Attribute) → object#

get_max_dim_x(self: tango._tango.Attribute) → int#: Get attribute maximum data size in x dimension. Set to 1 for scalar attribute

get_max_dim_y(self: tango._tango.Attribute) → int#: Get attribute maximum data size in y dimension. Set to 0 for scalar attribute

get_max_warning(self: tango._tango.Attribute) → object#

get_min_alarm(self: tango._tango.Attribute) → object#

get_min_warning(self: tango._tango.Attribute) → object#

get_name(self: tango._tango.Attribute) → str#: Get attribute name.

get_polling_period(self: tango._tango.Attribute) → int#: The attribute polling period in milliseconds. Set to 0 when the attribute is not polled

get_properties(attr_cfg: AttributeConfig | AttributeConfig_2 | AttributeConfig_3 | AttributeConfig_5 | MultiAttrProp = None) → AttributeConfig#

Get attribute properties.

Parameters:: conf (AttributeConfig or AttributeConfig_2 or AttributeConfig_3 or AttributeConfig_5 or MultiAttrProp) – the config object to be filled with the attribute configuration. Default is None meaning the method will create internally a new AttributeConfig_5 and return it.
Returns:: the config object filled with attribute configuration information
Return type:: AttributeConfig

Added in version 7.1.4.

get_quality(self: tango._tango.Attribute) → tango._tango.AttrQuality#: Get the attribute data quality.

get_writable(self: tango._tango.Attribute) → tango._tango.AttrWriteType#: Get the attribute writable type (RO/WO/RW).

get_x(self: tango._tango.Attribute) → int#: Get attribute data size in x dimension. Set to 1 for scalar attribute

get_y(self: tango._tango.Attribute) → int#: Get attribute data size in y dimension. Set to 0 for scalar attribute

is_alarm_event(self: tango._tango.Attribute) → bool#: Check if the alarm event is fired manually for this attribute. Returns True if a manual fire alarm event is implemented.

Added in version 10.0.0.

is_archive_event(self: tango._tango.Attribute) → bool#: Check if the archive event is fired manually (without polling) for this attribute. Returns True if a manual fire archive event is implemented. .. versionadded:: 7.1.0

is_change_event(self: tango._tango.Attribute) → bool#: Check if the change event is fired manually (without polling) for this attribute. Returns True if a manual fire change event is implemented.

Added in version 7.1.0.

is_check_alarm_criteria(self: tango._tango.Attribute) → bool#: Check if the alarm event criteria should be checked when firing the event manually. Returns True if a change event criteria will be checked.

Added in version 10.0.0.

is_check_archive_criteria(self: tango._tango.Attribute) → bool#: Check if the archive event criteria should be checked when firing the event manually. Returns True if a archive event criteria will be checked.

Added in version 7.1.0.

is_check_change_criteria(self: tango._tango.Attribute) → bool#: Check if the change event criteria should be checked when firing the event manually. Returns True if a change event criteria will be checked.

Added in version 7.1.0.

is_data_ready_event(self: tango._tango.Attribute) → bool#: Check if the data ready event is fired manually (without polling) for this attribute. Returns True if a manual fire data ready event is implemented.

Added in version 7.2.0.

is_event_subscribed(self: tango._tango.Attribute, event_type: tango._tango.EventType) → bool#

Returns true if there are any subscribers listening for particular event type.

Parameters:: event_type (EventType) – the event type to check

is_max_alarm(self: tango._tango.Attribute) → bool#: Check if the attribute is in maximum alarm condition (read value above the max. alarm).

is_max_warning(self: tango._tango.Attribute) → bool#: Check if the attribute is in maximum warning condition (read value above the max. warning).

is_min_alarm(self: tango._tango.Attribute) → bool#: Check if the attribute is in minimum alarm condition (read value below the min. alarm).

is_min_warning(self: tango._tango.Attribute) → bool#: Check if the attribute is in minimum warning condition (read value below the min. warning).

is_polled(self: tango._tango.Attribute) → bool#: Check if the attribute is polled.

is_rds_alarm(self: tango._tango.Attribute) → bool#: Check if the attribute is in RDS alarm condition (Read Different than Set).

is_write_associated(self: tango._tango.Attribute) → bool#: Check if the attribute has an associated writable attribute.

periodic_event_subscribed(self: tango._tango.Attribute) → bool#: Returns true if there are any subscribers listening for periodic event

Deprecated since version 10.3.0: Use is_event_subscribed() with EventType.PERIODIC_EVENT instead.

remove_configuration(self: tango._tango.Attribute) → None#

Remove the attribute configuration from the database.

This method can be used to clean-up all the configuration of an attribute to come back to its default values or the remove all configuration of a dynamic attribute before deleting it.

The method removes all configured attribute properties and removes the attribute from the list of polled attributes.

Added in version 7.1.0.

reset_value(self: tango._tango.Attribute) → None#: Clear attribute value

set_alarm_event(self: tango._tango.Attribute, implemented: bool, detect: bool = True) → None#

Set a flag to indicate that the server fires alarm events manually, without the polling to be started for the attribute.

If the detect parameter is set to true, the criteria specified for the alarm event (rel_change and abs_change) are verified and the event is only pushed if a least one of them are fulfilled (change in value compared to previous event exceeds a threshold). If detect is set to false the event is fired without any value checking!

Parameters:

implemented (bool) – True when the server fires alarm events manually.
detect (bool) – (optional, default is True) Triggers the verification of the alarm event properties when set to true.

Added in version 10.0.0.

set_archive_event(self: tango._tango.Attribute, implemented: bool, detect: bool = True) → None#

Set a flag to indicate that the server fires archive events manually, without the polling to be started for the attribute.

If the detect parameter is set to true, the criteria specified for the archive event (rel_change and abs_change) are verified and the event is only pushed if a least one of them are fulfilled (change in value compared to previous event exceeds a threshold).

If detect is set to false the event is fired without any value checking!

Parameters:

implemented (bool) – True when the server fires archive events manually.
detect (bool) – (optional, default is True) Triggers the verification of the archive event properties when set to true.

Added in version 7.1.0.

set_assoc_ind(self: tango._tango.Attribute, index: SupportsInt | SupportsIndex) → None#

Set index of the associated writable attribute.

Parameters:: index (int) – The new index in the main attribute vector of the associated writable attribute

set_attr_serial_model(self: tango._tango.Attribute, ser_model: tango._tango.AttrSerialModel) → None#

Set attribute serialization model.

This method allows the user to choose the attribute serialization model.

Parameters:: ser_model (AttrSerialModel) – The new serialisation model. The serialization model must be one of ATTR_BY_KERNEL, ATTR_BY_USER or ATTR_NO_SYNC

Added in version 7.1.0.

set_change_event(self: tango._tango.Attribute, implemented: bool, detect: bool = True) → None#

Set a flag to indicate that the server fires change events manually, without the polling to be started for the attribute.

If the detect parameter is set to true, the criteria specified for the change event (rel_change and abs_change) are verified and the event is only pushed if a least one of them are fulfilled (change in value compared to previous event exceeds a threshold). If detect is set to false the event is fired without any value checking!

Parameters:

implemented (bool) – True when the server fires change events manually.
detect (bool) – (optional, default is True) Triggers the verification of the change event properties when set to true.

Added in version 7.1.0.

set_data_ready_event(self: tango._tango.Attribute, implemented: bool) → None#

Set a flag to indicate that the server fires data ready events.

Parameters:: implemented (bool) – True when the server fires data ready events manually.

Added in version 7.2.0.

set_date(self: tango._tango.Attribute, new_date: tango._tango.TimeVal) → None#

Set attribute date.

Parameters:: new_date (TimeVal) – the attribute date

set_max_alarm(self: tango._tango.Attribute, value: object) → None#

set_max_warning(self: tango._tango.Attribute, value: object) → None#

set_min_alarm(self: tango._tango.Attribute, value: object) → None#

set_min_warning(self: tango._tango.Attribute, value: object) → None#

set_properties(attr_cfg: AttributeConfig | AttributeConfig_3, dev: DeviceImpl = None)#

Set attribute properties.

This method sets the attribute properties value with the content of the fields in the AttributeConfig/ AttributeConfig_3 object

Parameters:

conf (AttributeConfig or AttributeConfig_3) – the config object.
dev (DeviceImpl) – the device (not used, maintained for backward compatibility)

Added in version 7.1.4.

set_quality(self: tango._tango.Attribute, quality: tango._tango.AttrQuality, send_event: bool = False) → None#

Set attribute data quality.

Parameters:

quality (AttrQuality) – the new attribute data quality
send_event (bool) – true if a change event should be sent. Default is false.

set_upd_properties(*args, **kwargs)#

Overloaded function.

set_upd_properties(self: tango._tango.Attribute, attr_cfg: object) -> None
set_upd_properties(self: tango._tango.Attribute, attr_cfg: object, dev_name: object) -> None

set_value(self, data: Any) → None#

set_value(self, str_data: str, data: str) → None

Set internal attribute value.

This method stores the attribute read value inside the object. This method also stores the date when it is called and initializes the attribute quality factor.

Parameters:

data (Any | str) – the data to be set. Data must be compatible with the attribute type and format. E.g., sequence for SPECTRUM and a SEQUENCE of equal-length SEQUENCES for IMAGE attributes. The recommended sequence is a C continuous and aligned numpy array, as it can be optimized.
str_data (str) – special variation for DevEncoded data type. In this case ‘data’ must be a str or an object with the buffer interface.

Changed in version 10.1.0: The dim_x and dim_y parameters were removed.

set_value_date_quality(self, data: Any, time_stamp: float, quality: AttrQuality) → None#

set_value_date_quality(self, str_data: str, data: str, time_stamp: float, quality: AttrQuality) → None

Set internal attribute value, date and quality factor.

This method stores the attribute read value, the date and the attribute quality factor inside the object.

Parameters:

data – the data to be set. Data must be compatible with the attribute type and format. E.g., sequence for SPECTRUM and a SEQUENCE of equal-length SEQUENCES for IMAGE attributes. The recommended sequence is a C continuous and aligned numpy array, as it can be optimized.
str_data (str) – special variation for DevEncoded data type. In this case ‘data’ must be a str or an object with the buffer interface.
time_stamp (float) – the time stamp
quality (AttrQuality) – the attribute quality factor

Changed in version 10.1.0: The dim_x and dim_y parameters were removed.

use_notifd_event(self: tango._tango.Attribute) → bool#: Returns true if notifd events are emited

use_zmq_event(self: tango._tango.Attribute) → bool#: Returns true if zmq events are emited

user_event_subscribed(self: tango._tango.Attribute) → bool#: Returns true if there are any subscribers listening for user event

Deprecated since version 10.3.0: Use is_event_subscribed() with EventType.USER_EVENT instead.

value_is_set(self: tango._tango.Attribute) → bool#: Returns true if attribute has a value

WAttribute#

class tango.WAttribute#

This class represents a Tango writable attribute

get_max_value(self: tango._tango.WAttribute) → object#

Get attribute maximum value or throws an exception if the attribute does not have a maximum value.

Returns:: an object with the python maximum value
Return type:: typing.Any

get_min_value(self: tango._tango.WAttribute) → object#

Get attribute minimum value or throws an exception if the attribute does not have a minimum value.

Returns:: an object with the python minimum value
Return type:: typing.Any

get_write_value(self: tango._tango.WAttribute, extract_as: tango._tango.ExtractAs = ExtractAs.Numpy) → object#

Retrieve the new value for writable attribute.

Parameters:: extract_as (ExtractAs) – defaults to ExtractAs.Numpy
Returns:: the attribute write value.
Return type:: typing.Any

get_write_value_length(self: tango._tango.WAttribute) → int#: Retrieve the new value length (data number) for writable attribute.

is_max_value(self: tango._tango.WAttribute) → bool#: Check if the attribute has a maximum value.

is_min_value(self: tango._tango.WAttribute) → bool#: Check if the attribute has a minimum value.

set_max_value(self: tango._tango.WAttribute, value: object) → None#

Set attribute maximum value.

Parameters:: value (str) – the attribute maximum value. python data type must be compatible with the attribute data format and type

set_min_value(self: tango._tango.WAttribute, value: object) → None#

Set attribute minimum value.

Parameters:: value (str) – the attribute minimum value. python data type must be compatible with the attribute data format and type

set_write_value(self: tango._tango.WAttribute, value: object) → None#

Set the writable attribute value.

Parameters:: value (Any) – the data to be set. Data must be compatible with the attribute type and format. for SPECTRUM and IMAGE attributes, data can be any type of sequence of elements compatible with the attribute type

Changed in version 10.1.0: The dim_x and dim_y parameters were removed

MultiAttribute#

class tango.MultiAttribute#

check_alarm(*args, **kwargs)#

Overloaded function.

check_alarm(self: tango._tango.MultiAttribute) -> bool

Checks an alarm on all attribute(s) with an alarm defined. Returns True if at least one attribute is in alarm condition.

Throws:: DevFailed: If at least one attribute does not have any alarm level defined

Added in version 7.0.0.

check_alarm(self: tango._tango.MultiAttribute, ind: typing.SupportsInt | typing.SupportsIndex) -> bool

Checks an alarm for one attribute from its index in the main attributes vector.

Parameters:: ind (int) – the attribute index
Throws:: DevFailed: If at least one attribute does not have any alarm level defined

Added in version 7.0.0.

check_alarm(self: tango._tango.MultiAttribute, attr_name: str) -> bool

Checks an alarm for one attribute with a given name.

Parameters:: attr_name (str) – attribute name
Throws:: DevFailed: If at least one attribute does not have any alarm level defined

Added in version 7.0.0.

get_alarm_list(self: tango._tango.MultiAttribute) → tango._tango.StdLongVector#: A vector of int data. Each object is the index in the main attribute vector of attribute with alarm level defined

get_attr_by_ind(self: tango._tango.MultiAttribute, ind: SupportsInt | SupportsIndex) → tango._tango.Attribute#

Get Attribute object from its index.

This method returns an Attribute object from the index in the main attribute vector.

Parameters:: ind (int) – the attribute index

get_attr_by_name(self: tango._tango.MultiAttribute, attr_name: str) → tango._tango.Attribute#

Get Attribute object from its name.

This method returns an Attribute object with a name passed as parameter. The equality on attribute name is case independent.

Parameters:: attr_name (str) – attribute name
Returns:: the attribute object
Return type:: Attribute
Throws:: DevFailed: If the attribute is not defined

get_attr_ind_by_name(self: tango._tango.MultiAttribute, attr_name: str) → int#

Get Attribute index into the main attribute vector from its name.

This method returns the index in the Attribute vector (stored in the MultiAttribute object) of an attribute with a given name. The name equality is case independent.

Parameters:: attr_name (str) – attribute name
Throws:: DevFailed: If the attribute is not found in the vector.

Added in version 7.0.0.

get_attr_nb(self: tango._tango.MultiAttribute) → int#: Get the number of attributes.

Added in version 7.0.0.

get_attribute_list(self: tango._tango.MultiAttribute) → tuple[Attribute]#: Get the tuple of Attribute objects.

Changed in version 10.1.0: The return type was changed from AttributeList (now removed) to tuple[Attribute].

Added in version 7.2.1.

get_w_attr_by_ind(self: tango._tango.MultiAttribute, ind: SupportsInt | SupportsIndex) → tango._tango.WAttribute#

Get a writable attribute object from its index.

This method returns an WAttribute object from the index in the main attribute vector.

Parameters:: ind (int) – the attribute index

get_w_attr_by_name(self: tango._tango.MultiAttribute, attr_name: str) → tango._tango.WAttribute#

Get a writable attribute object from its name.

This method returns an WAttribute object with a name passed as parameter. The equality on attribute name is case independent.

Parameters:: attr_name (str) – attribute name
Throws:: DevFailed: If the attribute is not defined

read_alarm(self: tango._tango.MultiAttribute, status: str) → None#

Add alarm message to device status.

This method add alarm message to the string passed as parameter. A message is added for each attribute which is in alarm condition

Parameters:: status (str) – a string (should be the device status)

Added in version 7.0.0.

UserDefaultAttrProp#

class tango.UserDefaultAttrProp#

User class to set attribute default properties.

This class is used to set attribute default properties. Three levels of attributes properties setting are implemented within Tango. The highest property setting level is the database. Then the user default (set using this UserDefaultAttrProp class) and finally a Tango library default value

set_abs_change(self: tango._tango.UserDefaultAttrProp, def_abs_change: str) → None#

Set default change event abs_change property.

Parameters:: def_abs_change (str) – the user default change event abs_change property

Deprecated since version 8.0.: Please use set_event_abs_change instead.

set_archive_abs_change(self: tango._tango.UserDefaultAttrProp, def_archive_abs_change: str) → None#

Set default archive event abs_change property.

Parameters:: def_archive_abs_change (str) – the user default archive event abs_change property

Deprecated since version 8.0.: Please use set_archive_event_abs_change instead.

set_archive_event_abs_change(self: tango._tango.UserDefaultAttrProp, def_archive_abs_change: str) → None#

Set default archive event abs_change property.

Parameters:: def_archive_abs_change (str) – the user default archive event abs_change property

Added in version 8.0.

set_archive_event_period(self: tango._tango.UserDefaultAttrProp, def_archive_period: str) → None#

Set default archive event period property.

Parameters:: def_archive_period (str) – t

Added in version 8.0.

set_archive_event_rel_change(self: tango._tango.UserDefaultAttrProp, def_archive_rel_change: str) → None#

Set default archive event rel_change property.

Parameters:: def_archive_rel_change (str) – the user default archive event rel_change property

Added in version 8.0.

set_archive_period(self: tango._tango.UserDefaultAttrProp, def_archive_period: str) → None#

Set default archive event period property.

Parameters:: def_archive_period (str) – t

Deprecated since version 8.0.: Please use set_archive_event_period instead.

set_archive_rel_change(self: tango._tango.UserDefaultAttrProp, def_archive_rel_change: str) → None#

Set default archive event rel_change property.

Parameters:: def_archive_rel_change (str) – the user default archive event rel_change property

Deprecated since version 8.0.: Please use set_archive_event_rel_change instead.

set_delta_t(self: tango._tango.UserDefaultAttrProp, def_delta_t: str) → None#

Set default RDS alarm delta_t property.

Parameters:: def_delta_t (str) – the user default RDS alarm delta_t property

set_delta_val(self: tango._tango.UserDefaultAttrProp, def_delta_val: str) → None#

Set default RDS alarm delta_val property.

Parameters:: def_delta_val (str) – the user default RDS alarm delta_val property

set_description(self: tango._tango.UserDefaultAttrProp, def_description: str) → None#

Set default description property.

Parameters:: def_description (str) – the user default description property

set_display_unit(self: tango._tango.UserDefaultAttrProp, def_display_unit: str) → None#

Set default display unit property.

Parameters:: def_display_unit (str) – the user default display unit property

set_enum_labels(enum_labels: list[str])#

Set default enumeration labels.

Parameters:: enum_labels (:py:obj:list[str]) – list of enumeration labels

Added in version 9.2.0.

set_event_abs_change(self: tango._tango.UserDefaultAttrProp, def_abs_change: str) → None#

Set default change event abs_change property.

Parameters:: def_abs_change (str) – the user default change event abs_change property

Added in version 8.0.

set_event_period(self: tango._tango.UserDefaultAttrProp, def_period: str) → None#

Set default periodic event period property.

Parameters:: def_period (str) – the user default periodic event period property

Added in version 8.0.

set_event_rel_change(self: tango._tango.UserDefaultAttrProp, def_rel_change: str) → None#

Set default change event rel_change property.

Parameters:: def_rel_change (str) – the user default change event rel_change property

Added in version 8.0.

set_format(self: tango._tango.UserDefaultAttrProp, def_format: str) → None#

Set default format property.

Parameters:: def_format (str) – the user default format property

set_label(self: tango._tango.UserDefaultAttrProp, def_label: str) → None#

Set default label property.

Parameters:: def_label (str) – the user default label property

set_max_alarm(self: tango._tango.UserDefaultAttrProp, def_max_alarm: str) → None#

Set default max_alarm property.

Parameters:: def_max_alarm (str) – the user default max_alarm property

set_max_value(self: tango._tango.UserDefaultAttrProp, def_max_value: str) → None#

Set default max_value property.

Parameters:: def_max_value (str) – the user default max_value property

set_max_warning(self: tango._tango.UserDefaultAttrProp, def_max_warning: str) → None#

Set default max_warning property.

Parameters:: def_max_warning (str) – the user default max_warning property

set_min_alarm(self: tango._tango.UserDefaultAttrProp, def_min_alarm: str) → None#

Set default min_alarm property.

Parameters:: def_min_alarm (str) – the user default min_alarm property

set_min_value(self: tango._tango.UserDefaultAttrProp, def_min_value: str) → None#

Set default min_value property.

Parameters:: def_min_value (str) – the user default min_value property

set_min_warning(self: tango._tango.UserDefaultAttrProp, def_min_warning: str) → None#

Set default min_warning property.

Parameters:: def_min_warning (str) – the user default min_warning property

set_period(self: tango._tango.UserDefaultAttrProp, def_period: str) → None#

Set default periodic event period property.

Parameters:: def_period (str) – the user default periodic event period property

Deprecated since version 8.0.: Please use set_event_period instead.

set_rel_change(self: tango._tango.UserDefaultAttrProp, def_rel_change: str) → None#

Set default change event rel_change property.

Parameters:: def_rel_change (str) – the user default change event rel_change property

Deprecated since version 8.0.: Please use set_event_rel_change instead.

set_standard_unit(self: tango._tango.UserDefaultAttrProp, def_standard_unit: str) → None#

Set default standard unit property.

Parameters:: def_standard_unit (str) – the user default standard unit property

set_unit(self: tango._tango.UserDefaultAttrProp, def_unit: str) → None#

Set default unit property.

Parameters:: def_unit (str) – te user default unit property

Attribute Configs#

class tango.AttributeConfig#

property data_format#

property data_type#

property description#

property display_unit#

property extensions#

property format#

property label#

property max_alarm#

property max_dim_x#

property max_dim_y#

property max_value#

property min_alarm#

property min_value#

property name#

property standard_unit#

property unit#

property writable#

property writable_attr_name#

class tango.AttributeConfig_2#

property data_format#

property data_type#

property description#

property display_unit#

property extensions#

property format#

property label#

property level#

property max_alarm#

property max_dim_x#

property max_dim_y#

property max_value#

property min_alarm#

property min_value#

property name#

property standard_unit#

property unit#

property writable#

property writable_attr_name#

class tango.AttributeConfig_3#

property att_alarm#

property data_format#

property data_type#

property description#

property display_unit#

property event_prop#

property extensions#

property format#

property label#

property level#

property max_dim_x#

property max_dim_y#

property max_value#

property min_value#

property name#

property standard_unit#

property sys_extensions#

property unit#

property writable#

property writable_attr_name#

class tango.AttributeConfig_5#

property att_alarm#

property data_format#

property data_type#

property description#

property display_unit#

property enum_labels#

property event_prop#

property extensions#

property format#

property label#

property level#

property max_dim_x#

property max_dim_y#

property max_value#

property mem_init#

property memorized#

property min_value#

property name#

property root_attr_name#

property standard_unit#

property sys_extensions#

property unit#

property writable#

property writable_attr_name#

Multi Attribute Properties#

class tango.MultiAttrProp(label: str = '', description: str = '', unit: str = '', standard_unit: str = '', display_unit: str = '', format: str = '', min_value: str = '', max_value: str = '', min_alarm: str = '', max_alarm: str = '', min_warning: str = '', max_warning: str = '', delta_t: str = '', delta_val: str = '', event_period: str = '', archive_period: str = '', rel_change: str = '', abs_change: str = '', archive_rel_change: str = '', archive_abs_change: str = '')[source]#

This class represents the python interface for the Tango IDL object MultiAttrProp.

abs_change: str = ''#

archive_abs_change: str = ''#

archive_period: str = ''#

archive_rel_change: str = ''#

delta_t: str = ''#

delta_val: str = ''#

description: str = ''#

display_unit: str = ''#

event_period: str = ''#

format: str = ''#

label: str = ''#

max_alarm: str = ''#

max_value: str = ''#

max_warning: str = ''#

min_alarm: str = ''#

min_value: str = ''#

min_warning: str = ''#

rel_change: str = ''#

standard_unit: str = ''#

unit: str = ''#

Attribute classes

Contents

Attribute classes#

Attr#

Attribute#

WAttribute#

MultiAttribute#

UserDefaultAttrProp#

Attribute Configs#

Multi Attribute Properties#