Attribute classes

Contents

Attribute classes#

Attr#

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

check_type(self)

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_assoc (self) -> str

Get the associated name.

returns:

the associated name

rtype:

bool

get_cl_name(self: tango._tango.Attr) → str#

get_cl_name (self) -> str

Returns the class name.

returns:

the class name

rtype:

str

New in PyTango 7.2.0

get_class_properties(self: tango._tango.Attr) → list[Tango::AttrProperty]#

get_class_properties (self) -> Sequence[AttrProperty]

Get the class level attribute properties.

returns:

the class attribute properties

rtype:

Sequence[AttrProperty]

get_disp_level(self: tango._tango.Attr) → tango._tango.DispLevel#

get_disp_level (self) -> DispLevel

Get the attribute display level.

returns:

the attribute display level

rtype:

DispLevel

get_format(self: tango._tango.Attr) → tango._tango.AttrDataFormat#

get_format (self) -> AttrDataFormat

Get the attribute format.

returns:

the attribute format

rtype:

AttrDataFormat

get_memorized(self: tango._tango.Attr) → bool#

get_memorized (self) -> bool

Determine if the attribute is memorized or not.

returns:

True if the attribute is memorized

rtype:

bool

get_memorized_init(self: tango._tango.Attr) → bool#

get_memorized_init (self) -> bool

Determine if the attribute is written at startup from the memorized value if it is memorized.

returns:

True if initialized with memorized value or not

rtype:

bool

get_name(self: tango._tango.Attr) → str#

get_name (self) -> str

Get the attribute name.

returns:

the attribute name

rtype:

str

get_polling_period(self: tango._tango.Attr) → int#

get_polling_period (self) -> int

Get the polling period (mS).

returns:

the polling period (mS)

rtype:

int

get_type(self: tango._tango.Attr) → int#

get_type (self) -> int

Get the attribute data type.

returns:

the attribute data type

rtype:

int

get_user_default_properties(self: tango._tango.Attr) → list[Tango::AttrProperty]#

get_user_default_properties (self) -> Sequence[AttrProperty]

Get the user default attribute properties.

returns:

the user default attribute properties

rtype:

Sequence[AttrProperty]

get_writable(self: tango._tango.Attr) → tango._tango.AttrWriteType#

get_writable (self) -> AttrWriteType

Get the attribute write type.

returns:

the attribute write type

rtype:

AttrWriteType

is_alarm_event(self: tango._tango.Attr) → bool#
is_allowed(self: tango._tango.Attr, arg0: Tango::DeviceImpl, arg1: tango._tango.AttReqType) → bool#

is_allowed (self, device, request_type) -> bool

Returns whether the request_type is allowed for the specified device

param device:

instance of Device

type device:

tango.server.Device

param request_type:

AttReqType.READ_REQ for read request or AttReqType.WRITE_REQ for write request

type request_type:

AttReqType

returns:

True if request_type is allowed for the specified device

rtype:

bool

is_archive_event(self: tango._tango.Attr) → bool#

is_archive_event (self) -> bool

Check if the archive event is fired manually for this attribute.

returns:

true if a manual fire archive event is implemented.

rtype:

bool

is_assoc(self: tango._tango.Attr) → bool#

is_assoc (self) -> bool

Determine if it is assoc.

returns:

if it is assoc

rtype:

bool

is_change_event(self: tango._tango.Attr) → bool#

is_change_event (self) -> bool

Check if the change event is fired manually for this attribute.

returns:

true if a manual fire change event is implemented.

rtype:

bool

is_check_archive_criteria(self: tango._tango.Attr) → bool#

is_check_archive_criteria (self) -> 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.

rtype:

bool

is_check_change_criteria(self: tango._tango.Attr) → bool#

is_check_change_criteria (self) -> 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.

rtype:

bool

is_data_ready_event(self: tango._tango.Attr) → bool#

is_data_ready_event (self) -> bool

Check if the data ready event is fired for this attribute.

returns:

true if firing data ready event is implemented.

rtype:

bool

New in PyTango 7.2.0

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

set_alarm_event(self, implemented, detect)

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!

param implemented:

True when the server fires alarm events manually.

type implemented:

bool

param detect:

Triggers the verification of the alarm event properties when set to true.

type detect:

bool

Added in version 10.0.0.

set_archive_event(self: tango._tango.Attr, arg0: bool, arg1: bool) → None#

set_archive_event(self)

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!

param implemented:

True when the server fires change events manually.

type implemented:

bool

param detect:

Triggers the verification of the archive event properties when set to true.

type detect:

bool

set_change_event(self: tango._tango.Attr, arg0: bool, arg1: bool) → None#

set_change_event(self, implemented, detect)

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!

param implemented:

True when the server fires change events manually.

type implemented:

bool

param detect:

Triggers the verification of the change event properties when set to true.

type detect:

bool

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

set_cl_name(self, cl)

Sets the class name.

param cl:

new class name

type cl:

str

New in PyTango 7.2.0

set_class_properties(self: tango._tango.Attr, arg0: list[Tango::AttrProperty]) → None#

set_class_properties(self, props)

Set the class level attribute properties.

param props:

new class level attribute properties

type props:

StdAttrPropertyVector

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

set_data_ready_event(self, implemented)

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

param implemented:

True when the server fires data ready events

type implemented:

bool

New in PyTango 7.2.0

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

set_default_properties(self)

Set default attribute properties.

param attr_prop:

the user default property class

type attr_prop:

UserDefaultAttrProp

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

set_disp_level(self, disp_level)

Set the attribute display level.

param disp_level:

the new display level

type disp_level:

DispLevel

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

set_memorized(self)

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, arg0: bool) → None#

set_memorized_init(self, write_on_init)

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

param write_on_init:

if true the setpoint value will be written to the attribute on initialisation

type write_on_init:

bool

set_polling_period(self: tango._tango.Attr, arg0: int) → None#

set_polling_period(self, period)

Set the attribute polling update period.

param period:

the attribute polling period (in mS)

type period:

int

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

Attribute#

class tango.Attribute#

This class represents a Tango attribute

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

check_alarm (self) -> bool

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

returns:

true if the attribute is in alarm condition.

rtype:

bool

raises DevFailed:

If no alarm level is defined.

fire_alarm_event(*args, **kwargs)#

Overloaded function.

  1. fire_alarm_event(self: tango._tango.Attribute) -> None

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

fire_change_event(*args, **kwargs)#

Overloaded function.

  1. fire_change_event(self: tango._tango.Attribute) -> None

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

get_assoc_ind(self: tango._tango.Attribute) → int#

get_assoc_ind (self) -> int

Get index of the associated writable attribute.

returns:

the index in the main attribute vector of the associated writable attribute

rtype:

int

get_assoc_name(self: tango._tango.Attribute) → str#

get_assoc_name (self) -> str

Get name of the associated writable attribute.

returns:

the associated writable attribute name

rtype:

str

get_attr_serial_model(self: tango._tango.Attribute) → tango._tango.AttrSerialModel#

get_attr_serial_model (self) -> AttrSerialModel

Get attribute serialization model.

returns:

The attribute serialization model

rtype:

AttrSerialModel

New in PyTango 7.1.0

get_data_format(self: tango._tango.Attribute) → tango._tango.AttrDataFormat#

get_data_format (self) -> AttrDataFormat

Get attribute data format.

returns:

the attribute data format

rtype:

AttrDataFormat

get_data_size(self: tango._tango.Attribute) → int#

get_data_size(self)

Get attribute data size.

returns:

the attribute data size

rtype:

int

get_data_type(self: tango._tango.Attribute) → int#

get_data_type (self) -> int

Get attribute data type.

returns:

the attribute data type

rtype:

int

get_date(self: tango._tango.Attribute) → tango._tango.TimeVal#

get_date (self) -> TimeVal

Get a COPY of the attribute date.

returns:

the attribute date

rtype:

TimeVal

get_disp_level(self: tango._tango.Attribute) → tango._tango.DispLevel#
get_label(self: tango._tango.Attribute) → str#

get_label (self, ) -> str

Get attribute label property.

returns:

the attribute label

rtype:

str

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

get_max_dim_x (self) -> int

Get attribute maximum data size in x dimension.

returns:

the attribute maximum data size in x dimension. Set to 1 for scalar attribute

rtype:

int

get_max_dim_y(self: tango._tango.Attribute) → int#

get_max_dim_y (self) -> int

Get attribute maximum data size in y dimension.

returns:

the attribute maximum data size in y dimension. Set to 0 for scalar attribute

rtype:

int

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_name (self) -> str

Get attribute name.

returns:

The attribute name

rtype:

str

get_polling_period(self: tango._tango.Attribute) → int#

get_polling_period (self) -> int

Get attribute polling period.

returns:

The attribute polling period in mS. Set to 0 when the attribute is not polled

rtype:

int

get_properties(self, attr_cfg=None) → AttributeConfig#

Get attribute properties.

Parameters:

conf – 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. Can be AttributeConfig, AttributeConfig_2, AttributeConfig_3, AttributeConfig_5 or MultiAttrProp

Returns:

the config object filled with attribute configuration information

Return type:

AttributeConfig

New in PyTango 7.1.4

get_quality(self: tango._tango.Attribute) → tango._tango.AttrQuality#

get_quality (self) -> AttrQuality

Get a COPY of the attribute data quality.

returns:

the attribute data quality

rtype:

AttrQuality

get_writable(self: tango._tango.Attribute) → tango._tango.AttrWriteType#

get_writable (self) -> AttrWriteType

Get the attribute writable type (RO/WO/RW).

returns:

The attribute write type.

rtype:

AttrWriteType

get_x(self: tango._tango.Attribute) → int#

get_x (self) -> int

Get attribute data size in x dimension.

returns:

the attribute data size in x dimension. Set to 1 for scalar attribute

rtype:

int

get_y(self: tango._tango.Attribute) → int#

get_y (self) -> int

Get attribute data size in y dimension.

returns:

the attribute data size in y dimension. Set to 0 for scalar attribute

rtype:

int

is_alarm_event(self: tango._tango.Attribute) → bool#
is_archive_event(self: tango._tango.Attribute) → bool#

is_archive_event (self) -> bool

Check if the archive event is fired manually (without polling) for this attribute.

returns:

True if a manual fire archive event is implemented.

rtype:

bool

New in PyTango 7.1.0

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

is_change_event (self) -> bool

Check if the change event is fired manually (without polling) for this attribute.

returns:

True if a manual fire change event is implemented.

rtype:

bool

New in PyTango 7.1.0

is_check_alarm_criteria(self: tango._tango.Attribute) → bool#
is_check_archive_criteria(self: tango._tango.Attribute) → bool#

is_check_archive_criteria (self) -> 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.

rtype:

bool

New in PyTango 7.1.0

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

is_check_change_criteria (self) -> 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.

rtype:

bool

New in PyTango 7.1.0

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

is_data_ready_event (self) -> 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.

rtype:

bool

New in PyTango 7.2.0

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

is_max_alarm (self) -> bool

Check if the attribute is in maximum alarm condition.

returns:

true if the attribute is in alarm condition (read value above the max. alarm).

rtype:

bool

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

is_max_warning (self) -> bool

Check if the attribute is in maximum warning condition.

returns:

true if the attribute is in warning condition (read value above the max. warning).

rtype:

bool

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

is_min_alarm (self) -> bool

Check if the attribute is in minimum alarm condition.

returns:

true if the attribute is in alarm condition (read value below the min. alarm).

rtype:

bool

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

is_min_warning (self) -> bool

Check if the attribute is in minimum warning condition.

returns:

true if the attribute is in warning condition (read value below the min. warning).

rtype:

bool

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

is_polled (self) -> bool

Check if the attribute is polled.

returns:

true if the attribute is polled.

rtype:

bool

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

is_rds_alarm (self) -> bool

Check if the attribute is in RDS alarm condition.

returns:

true if the attribute is in RDS condition (Read Different than Set).

rtype:

bool

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

is_write_associated (self) -> bool

Check if the attribute has an associated writable attribute.

returns:

True if there is an associated writable attribute

rtype:

bool

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

remove_configuration(self)

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.

New in PyTango 7.1.0

reset_value(self: tango._tango.Attribute) → None#
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.

New in PyTango 7.1.0

set_assoc_ind(self: tango._tango.Attribute, arg0: int) → None#

set_assoc_ind(self, index)

Set index of the associated writable attribute.

param index:

The new index in the main attribute vector of the associated writable attribute

type index:

int

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

set_attr_serial_model (self, ser_model) -> void

Set attribute serialization model.

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

param ser_model:

The new serialisation model. The serialization model must be one of ATTR_BY_KERNEL, ATTR_BY_USER or ATTR_NO_SYNC

type ser_model:

AttrSerialModel

New in PyTango 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.

New in PyTango 7.1.0

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

set_data_ready_event(self, implemented)

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

param implemented:

True when the server fires data ready events manually.

type implemented:

bool

New in PyTango 7.2.0

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

set_date(self, new_date)

Set attribute date.

param new_date:

the attribute date

type new_date:

TimeVal

set_max_alarm(self: tango._tango.Attribute, arg0: object) → None#
set_max_warning(self: tango._tango.Attribute, arg0: object) → None#
set_min_alarm(self: tango._tango.Attribute, arg0: object) → None#
set_min_warning(self: tango._tango.Attribute, arg0: object) → None#
set_properties(self, attr_cfg, dev)#

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)

New in PyTango 7.1.4

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

set_quality(self, quality, send_event=False)

Set attribute data quality.

param quality:

the new attribute data quality

type quality:

AttrQuality

param send_event:

true if a change event should be sent. Default is false.

type send_event:

bool

set_upd_properties(*args, **kwargs)#

Overloaded function.

  1. set_upd_properties(self: tango._tango.Attribute, arg0: object) -> None

  2. set_upd_properties(self: tango._tango.Attribute, arg0: object, arg1: object) -> None

set_value(*args)#
set_value(self, data)
set_value(self, str_data, data)

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 – 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(*args)#
set_value_date_quality(self, data, time_stamp, quality)
set_value_date_quality(self, str_data, data, time_stamp, quality)

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 (double) – 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#
use_zmq_event(self: tango._tango.Attribute) → bool#
user_event_subscribed(self: tango._tango.Attribute) → bool#
value_is_set(self: tango._tango.Attribute) → bool#

WAttribute#

class tango.WAttribute#

This class represents a Tango writable attribute

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

get_max_value (self) -> obj

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

rtype:

obj

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

get_min_value (self) -> obj

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

rtype:

obj

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

get_write_value (self, extract_as=ExtractAs.Numpy) -> obj

Retrieve the new value for writable attribute.

param extract_as:

defaults to ExtractAs.Numpy

type extract_as:

ExtractAs

returns:

the attribute write value.

rtype:

obj

get_write_value_length(self: tango._tango.WAttribute) → int#

get_write_value_length (self) -> int

Retrieve the new value length (data number) for writable attribute.

returns:

the new value data length

rtype:

int

is_max_value(self: tango._tango.WAttribute) → bool#

is_max_value (self, ) -> bool

Check if the attribute has a maximum value.

returns:

true if the attribute has a maximum value defined

rtype:

bool

is_min_value(self: tango._tango.WAttribute) → bool#

is_min_value (self) -> bool

Check if the attribute has a minimum value.

returns:

true if the attribute has a minimum value defined

rtype:

bool

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

set_max_value(self, data)

Set attribute maximum value.

param data:

the attribute maximum value. python data type must be compatible with the attribute data format and type.

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

set_min_value(self, data)

Set attribute minimum value.

param data:

the attribute minimum value. python data type must be compatible with the attribute data format and type.

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

set_write_value(self, data)

Set the writable attribute value.

param data:

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.

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

    check_alarm(self) -> bool

    Checks an alarm on all attribute(s) with an alarm defined.

    returns:

    True if at least one attribute is in alarm condition

    rtype:

    bool

    raises DevFailed:

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

    New in PyTango 7.0.0

  2. check_alarm(self: tango._tango.MultiAttribute, arg0: int) -> bool

    check_alarm(self, ind) -> bool

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

    param ind:

    the attribute index

    type ind:

    int

    returns:

    True if attribute is in alarm condition

    rtype:

    bool

    raises DevFailed:

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

    New in PyTango 7.0.0

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

    check_alarm(self, attr_name) -> bool

    Checks an alarm for one attribute with a given name. - The 3rd version of the method checks alarm for one attribute from its index in the main attributes vector.

    param attr_name:

    attribute name

    type attr_name:

    str

    returns:

    True if attribute is in alarm condition

    rtype:

    bool

    raises DevFailed:

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

    New in PyTango 7.0.0

get_alarm_list(self: tango._tango.MultiAttribute) → tango._tango.StdLongVector#
get_attr_by_ind(self: tango._tango.MultiAttribute, arg0: int) → tango._tango.Attribute#

get_attr_by_ind (self, ind) -> Attribute

Get Attribute object from its index.

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

param ind:

the attribute index

type ind:

int

returns:

the attribute object

rtype:

Attribute

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

get_attr_by_name (self, attr_name) -> 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.

param attr_name:

attribute name

type attr_name:

str

returns:

the attribute object

rtype:

Attribute

raises DevFailed:

If the attribute is not defined.

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

get_attr_ind_by_name (self, attr_name) -> 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.

param attr_name:

attribute name

type attr_name:

str

returns:

the attribute index

rtype:

int

raises DevFailed:

If the attribute is not found in the vector.

New in PyTango 7.0.0

get_attr_nb(self: tango._tango.MultiAttribute) → int#

get_attr_nb (self) -> int

Get the number of attributes.

returns:

the number of attributes

rtype:

int

New in PyTango 7.0.0

get_attribute_list(self: tango._tango.MultiAttribute) → tango._tango.AttributeList#

get_attribute_list (self) -> Sequence[Attribute]

Get the list of attribute objects.

returns:

list of attribute objects

rtype:

Sequence[Attribute]

New in PyTango 7.2.1

get_w_attr_by_ind(self: tango._tango.MultiAttribute, arg0: int) → tango._tango.WAttribute#

get_w_attr_by_ind (self, ind) -> WAttribute

Get a writable attribute object from its index.

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

param ind:

the attribute index

type ind:

int

returns:

the attribute object

rtype:

WAttribute

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

get_w_attr_by_name (self, attr_name) -> 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.

param attr_name:

attribute name

type attr_name:

str

returns:

the attribute object

rtype:

WAttribute

raises DevFailed:

If the attribute is not defined.

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

read_alarm(self, status)

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

param status:

a string (should be the device status)

type status:

str

New in PyTango 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, arg0: str) → None#

set_abs_change(self, def_abs_change) <= DEPRECATED

Set default change event abs_change property.

param def_abs_change:

the user default change event abs_change property

type def_abs_change:

str

Deprecated since PyTango 8.0. Please use set_event_abs_change instead.

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

set_archive_abs_change(self, def_archive_abs_change) <= DEPRECATED

Set default archive event abs_change property.

param def_archive_abs_change:

the user default archive event abs_change property

type def_archive_abs_change:

str

Deprecated since PyTango 8.0. Please use set_archive_event_abs_change instead.

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

set_archive_event_abs_change(self, def_archive_abs_change)

Set default archive event abs_change property.

param def_archive_abs_change:

the user default archive event abs_change property

type def_archive_abs_change:

str

New in PyTango 8.0

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

set_archive_event_period(self, def_archive_period)

Set default archive event period property.

param def_archive_period:

t

type def_archive_period:

str

New in PyTango 8.0

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

set_archive_event_rel_change(self, def_archive_rel_change)

Set default archive event rel_change property.

param def_archive_rel_change:

the user default archive event rel_change property

type def_archive_rel_change:

str

New in PyTango 8.0

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

set_archive_period(self, def_archive_period) <= DEPRECATED

Set default archive event period property.

param def_archive_period:

t

type def_archive_period:

str

Deprecated since PyTango 8.0. Please use set_archive_event_period instead.

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

set_archive_rel_change(self, def_archive_rel_change) <= DEPRECATED

Set default archive event rel_change property.

param def_archive_rel_change:

the user default archive event rel_change property

type def_archive_rel_change:

str

Deprecated since PyTango 8.0. Please use set_archive_event_rel_change instead.

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

set_delta_t(self, def_delta_t)

Set default RDS alarm delta_t property.

param def_delta_t:

the user default RDS alarm delta_t property

type def_delta_t:

str

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

set_delta_val(self, def_delta_val)

Set default RDS alarm delta_val property.

param def_delta_val:

the user default RDS alarm delta_val property

type def_delta_val:

str

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

set_description(self, def_description)

Set default description property.

param def_description:

the user default description property

type def_description:

str

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

set_display_unit(self, def_display_unit)

Set default display unit property.

param def_display_unit:

the user default display unit property

type def_display_unit:

str

set_enum_labels(self, enum_labels)#

Set default enumeration labels.

Parameters:

enum_labels (Sequence[str]) – list of enumeration labels

New in PyTango 9.2.0

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

set_event_abs_change(self, def_abs_change)

Set default change event abs_change property.

param def_abs_change:

the user default change event abs_change property

type def_abs_change:

str

New in PyTango 8.0

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

set_event_period(self, def_period)

Set default periodic event period property.

param def_period:

the user default periodic event period property

type def_period:

str

New in PyTango 8.0

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

set_event_rel_change(self, def_rel_change)

Set default change event rel_change property.

param def_rel_change:

the user default change event rel_change property

type def_rel_change:

str

New in PyTango 8.0

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

set_format(self, def_format)

Set default format property.

param def_format:

the user default format property

type def_format:

str

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

set_label(self, def_label)

Set default label property.

param def_label:

the user default label property

type def_label:

str

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

set_max_alarm(self, def_max_alarm)

Set default max_alarm property.

param def_max_alarm:

the user default max_alarm property

type def_max_alarm:

str

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

set_max_value(self, def_max_value)

Set default max_value property.

param def_max_value:

the user default max_value property

type def_max_value:

str

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

set_max_warning(self, def_max_warning)

Set default max_warning property.

param def_max_warning:

the user default max_warning property

type def_max_warning:

str

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

set_min_alarm(self, def_min_alarm)

Set default min_alarm property.

param def_min_alarm:

the user default min_alarm property

type def_min_alarm:

str

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

set_min_value(self, def_min_value)

Set default min_value property.

param def_min_value:

the user default min_value property

type def_min_value:

str

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

set_min_warning(self, def_min_warning)

Set default min_warning property.

param def_min_warning:

the user default min_warning property

type def_min_warning:

str

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

set_period(self, def_period) <= DEPRECATED

Set default periodic event period property.

param def_period:

the user default periodic event period property

type def_period:

str

Deprecated since PyTango 8.0. Please use set_event_period instead.

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

set_rel_change(self, def_rel_change) <= DEPRECATED

Set default change event rel_change property.

param def_rel_change:

the user default change event rel_change property

type def_rel_change:

str

Deprecated since PyTango 8.0. Please use set_event_rel_change instead.

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

set_standard_unit(self, def_standard_unit)

Set default standard unit property.

param def_standard_unit:

the user default standard unit property

type def_standard_unit:

str

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

set_unit(self, def_unit)

Set default unit property.

param def_unit:

te user default unit property

type def_unit:

str

Contents