Base class for all TANGO device. This class inherits from CORBA classes where all the network layer is implemented.
Add a new attribute to the device attribute list. Please, note that if you add an attribute to a device at device creation time, this attribute will be added to the device class attribute list. Therefore, all devices belonging to the same class created after this attribute addition will also have this attribute.
Parameters : |
|
||||||||
---|---|---|---|---|---|---|---|---|---|
Return : | (Attr) the newly created attribute. |
||||||||
Throws : |
Appends a string to the device status.
Parameters: status : (str) the string to be appened to the device status new_line : (bool) If true, appends a new line character before the string. Default is False Return: None
This method check that a command is supported by the device and does not need input value. The method throws an exception if the command is not defined or needs an input value
Parameters:
cmd_name: (str) the command name Return: None
Throws: DevFailed API_IncompatibleCmdArgumentType, API_CommandNotFound
New in PyTango 7.1.2
Sends the given message to the tango debug stream.
Since PyTango 7.1.3, the same can be achieved with:
print(msg, file=self.log_debug)
Parameters : |
|
||
---|---|---|---|
Return : | None |
Get device state. Default method to get device state. The behaviour of this method depends on the device state. If the device state is ON or ALARM, it reads the attribute(s) with an alarm level defined, check if the read value is above/below the alarm and eventually change the state to ALARM, return the device state. For all th other device state, this method simply returns the state This method can be redefined in sub-classes in case of the default behaviour does not fullfill the needs.
Parameters: None Return: (DevState) the device state Throws: DevFailed - If it is necessary to read attribute(s) and a problem occurs during the reading
Get device status. Default method to get device status. It returns the contents of the device dev_status field. If the device state is ALARM, alarm messages are added to the device status. This method can be redefined in sub-classes in case of the default behaviour does not fullfill the needs.
Parameters: None Return: (str) the device status Throws: DevFailed - If it is necessary to read attribute(s) and a problem occurs during the reading
Sends the given message to the tango error stream.
Since PyTango 7.1.3, the same can be achieved with:
print(msg, file=self.log_error)
Parameters : |
|
||
---|---|---|---|
Return : | None |
Sends the given message to the tango fatal stream.
Since PyTango 7.1.3, the same can be achieved with:
print(msg, file=self.log_fatal)
Parameters : |
|
||
---|---|---|---|
Return : | None |
Returns the min attribute poll period
Parameters: None Return: (seq) the min attribute poll period New in PyTango 7.2.0
Returns the min command poll period
Parameters: None Return: (seq) the min command poll period New in PyTango 7.2.0
Get device multi attribute object.
Parameters: None Return: (MultiAttribute) the device’s MultiAttribute object
Utility method that fetches all the device properties from the database and converts them into members of this DeviceImpl.
Parameters : |
|
||
---|---|---|---|
Return : | None |
||
Throws : |
Returns the state of the exported flag
Parameters: None Return: (bool) the state of the exported flag New in PyTango 7.1.2
Returns the Logger object for this device
Parameters: None Return: (Logger) the Logger object for this device
Get a COPY of the device name.
Parameters: None Return: (str) the device name
Returns a COPY of the list of non automatic polled attributes
Parameters: None Return: (sequence<str>) a COPY of the list of non automatic polled attributes New in PyTango 7.1.2
Returns a COPY of the list of non automatic polled commands
Parameters: None Return: (sequence<str>) a COPY of the list of non automatic polled commands New in PyTango 7.1.2
Returns a COPY of the list of polled attributes
Parameters: None Return: (sequence<str>) a COPY of the list of polled attributes New in PyTango 7.1.2
Returns a COPY of the list of polled commands
Parameters: None Return: (sequence<str>) a COPY of the list of polled commands New in PyTango 7.1.2
Get a COPY of the device’s previous state.
Parameters: None Return: (DevState) the device’s previous state
Get a COPY of the device state.
Parameters: None Return: (DevState) Current device state
Get a COPY of the device status.
Parameters: None Return: (str) the device status
Sends the given message to the tango info stream.
Since PyTango 7.1.3, the same can be achieved with:
print(msg, file=self.log_info)
Parameters : |
|
||
---|---|---|---|
Return : | None |
Intialise a device.
Parameters: None Return: None
Returns if this device is locked by a client
Parameters: None Return: (bool) True if it is locked or False otherwise New in PyTango 7.1.2
Returns if it is polled
Parameters: None Return: (bool) True if it is polled or False otherwise New in PyTango 7.1.2
push_archive_event (self, attr_name, except) -> None
push_archive_event (self, attr_name, data, dim_x = 1, dim_y = 0) -> None
push_archive_event (self, attr_name, str_data, data) -> None
push_archive_event (self, attr_name, data, time_stamp, quality, dim_x = 1, dim_y = 0) -> None
push_archive_event (self, attr_name, str_data, data, time_stamp, quality) -> None
Push an archive event for the given attribute name. The event is pushed to the notification daemon.
Parameters:
attr_name: (str) attribute name data: the data to be sent as attribute event data. 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 str_data: (str) special variation for DevEncoded data type. In this case ‘data’ must be a str or an object with the buffer interface. except: (DevFailed) Instead of data, you may want to send an exception. dim_x: (int) the attribute x length. Default value is 1 dim_y: (int) the attribute y length. Default value is 0 time_stamp: (double) the time stamp quality: (AttrQuality) the attribute quality factor Throws: DevFailed If the attribute data type is not coherent.
Push an attribute configuration event.
Parameters: (Attribute) the attribute for which the configuration event will be sent. Return: None New in PyTango 7.2.1
push_change_event (self, attr_name, except) -> None
push_change_event (self, attr_name, data, dim_x = 1, dim_y = 0) -> None
push_change_event (self, attr_name, str_data, data) -> None
push_change_event (self, attr_name, data, time_stamp, quality, dim_x = 1, dim_y = 0) -> None
push_change_event (self, attr_name, str_data, data, time_stamp, quality) -> None
Push a change event for the given attribute name. The event is pushed to the notification daemon.
Parameters:
attr_name: (str) attribute name data: the data to be sent as attribute event data. 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 str_data: (str) special variation for DevEncoded data type. In this case ‘data’ must be a str or an object with the buffer interface. except: (DevFailed) Instead of data, you may want to send an exception. dim_x: (int) the attribute x length. Default value is 1 dim_y: (int) the attribute y length. Default value is 0 time_stamp: (double) the time stamp quality: (AttrQuality) the attribute quality factor Throws: DevFailed If the attribute data type is not coherent.
Push a data ready event for the given attribute name. The event is pushed to the notification daemon.
The method needs only the attribue name and an optional “counter” which will be passed unchanged within the event
Parameters:
attr_name: (str) attribute name counter: (int) the user counter Return: None
Throws: DevFailed If the attribute name is unknown.
push_event (self, attr_name, filt_names, filt_vals, data, dim_x = 1, dim_y = 0) -> None
push_event (self, attr_name, filt_names, filt_vals, str_data, data) -> None
push_event (self, attr_name, filt_names, filt_vals, data, time_stamp, quality, dim_x = 1, dim_y = 0) -> None
push_event (self, attr_name, filt_names, filt_vals, str_data, data, time_stamp, quality) -> None
Push a user event for the given attribute name. The event is pushed to the notification daemon.
Parameters:
attr_name: (str) attribute name filt_names: (sequence<str>) the filterable fields name filt_vals: (sequence<double>) the filterable fields value data: the data to be sent as attribute event data. 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 str_data: (str) special variation for DevEncoded data type. In this case ‘data’ must be a str or an object with the buffer interface. dim_x: (int) the attribute x length. Default value is 1 dim_y: (int) the attribute y length. Default value is 0 time_stamp: (double) the time stamp quality: (AttrQuality) the attribute quality factor Throws: DevFailed If the attribute data type is not coherent.
Register a signal. Register this device as device to be informed when signal signo is sent to to the device server process
Parameters:
signo: (int) signal identifier Return: None
Remove one attribute from the device attribute list.
Parameters : |
|
||
---|---|---|---|
Return : | None |
||
Throws : |
Set an implemented flag for the attribute to indicate that the server fires archive events manually, without the polling to be started. If the detect parameter is set to true, the criteria specified for the archive event are verified and the event is only pushed if they are fullfilled. If detect is set to false the event is fired without any value checking!
Parameters:
attr_name: (str) attribute name implemented: (bool) True when the server fires change events manually. detect: (bool) Triggers the verification of the change event properties when set to true. Default value is true. Return: None
Set an implemented flag for the attribute to indicate that the server fires change events manually, without the polling to be started. If the detect parameter is set to true, the criteria specified for the change event are verified and the event is only pushed if they are fullfilled. If detect is set to false the event is fired without any value checking!
Parameters:
attr_name: (str) attribute name implemented: (bool) True when the server fires change events manually. detect: (bool) Triggers the verification of the change event properties when set to true. Default value is true. Return: None
Set device state.
Parameters:
new_state: (DevState) the new device state Return: None
Set device status.
Parameters:
new_status: (str) the new device status Return: None
stop_polling (self, with_db_upd) -> None
Stop all polling for a device. if the device is polled, call this method before deleting it.
Parameters:
with_db_upd: (bool) Is it necessary to update db ? Return: None
New in PyTango 7.1.2
Bases: PyTango._PyTango.DeviceImpl
Add a new attribute to the device attribute list. Please, note that if you add an attribute to a device at device creation time, this attribute will be added to the device class attribute list. Therefore, all devices belonging to the same class created after this attribute addition will also have this attribute.
Parameters : |
|
||||||||
---|---|---|---|---|---|---|---|---|---|
Return : | (Attr) the newly created attribute. |
||||||||
Throws : |
Appends a string to the device status.
Parameters: status : (str) the string to be appened to the device status new_line : (bool) If true, appends a new line character before the string. Default is False Return: None
This method check that a command is supported by the device and does not need input value. The method throws an exception if the command is not defined or needs an input value
Parameters:
cmd_name: (str) the command name Return: None
Throws: DevFailed API_IncompatibleCmdArgumentType, API_CommandNotFound
New in PyTango 7.1.2
Sends the given message to the tango debug stream.
Since PyTango 7.1.3, the same can be achieved with:
print(msg, file=self.log_debug)
Parameters : |
|
||
---|---|---|---|
Return : | None |
Get device state. Default method to get device state. The behaviour of this method depends on the device state. If the device state is ON or ALARM, it reads the attribute(s) with an alarm level defined, check if the read value is above/below the alarm and eventually change the state to ALARM, return the device state. For all th other device state, this method simply returns the state This method can be redefined in sub-classes in case of the default behaviour does not fullfill the needs.
Parameters: None Return: (DevState) the device state Throws: DevFailed - If it is necessary to read attribute(s) and a problem occurs during the reading
Get device status. Default method to get device status. It returns the contents of the device dev_status field. If the device state is ALARM, alarm messages are added to the device status. This method can be redefined in sub-classes in case of the default behaviour does not fullfill the needs.
Parameters: None Return: (str) the device status Throws: DevFailed - If it is necessary to read attribute(s) and a problem occurs during the reading
Sends the given message to the tango error stream.
Since PyTango 7.1.3, the same can be achieved with:
print(msg, file=self.log_error)
Parameters : |
|
||
---|---|---|---|
Return : | None |
Sends the given message to the tango fatal stream.
Since PyTango 7.1.3, the same can be achieved with:
print(msg, file=self.log_fatal)
Parameters : |
|
||
---|---|---|---|
Return : | None |
Returns the min attribute poll period
Parameters: None Return: (seq) the min attribute poll period New in PyTango 7.2.0
Returns the min command poll period
Parameters: None Return: (seq) the min command poll period New in PyTango 7.2.0
Get device multi attribute object.
Parameters: None Return: (MultiAttribute) the device’s MultiAttribute object
Utility method that fetches all the device properties from the database and converts them into members of this DeviceImpl.
Parameters : |
|
||
---|---|---|---|
Return : | None |
||
Throws : |
Returns the state of the exported flag
Parameters: None Return: (bool) the state of the exported flag New in PyTango 7.1.2
Returns the Logger object for this device
Parameters: None Return: (Logger) the Logger object for this device
Get a COPY of the device name.
Parameters: None Return: (str) the device name
Returns a COPY of the list of non automatic polled attributes
Parameters: None Return: (sequence<str>) a COPY of the list of non automatic polled attributes New in PyTango 7.1.2
Returns a COPY of the list of non automatic polled commands
Parameters: None Return: (sequence<str>) a COPY of the list of non automatic polled commands New in PyTango 7.1.2
Returns a COPY of the list of polled attributes
Parameters: None Return: (sequence<str>) a COPY of the list of polled attributes New in PyTango 7.1.2
Returns a COPY of the list of polled commands
Parameters: None Return: (sequence<str>) a COPY of the list of polled commands New in PyTango 7.1.2
Get a COPY of the device’s previous state.
Parameters: None Return: (DevState) the device’s previous state
Get a COPY of the device state.
Parameters: None Return: (DevState) Current device state
Get a COPY of the device status.
Parameters: None Return: (str) the device status
Sends the given message to the tango info stream.
Since PyTango 7.1.3, the same can be achieved with:
print(msg, file=self.log_info)
Parameters : |
|
||
---|---|---|---|
Return : | None |
Intialise a device.
Parameters: None Return: None
Returns if this device is locked by a client
Parameters: None Return: (bool) True if it is locked or False otherwise New in PyTango 7.1.2
Returns if it is polled
Parameters: None Return: (bool) True if it is polled or False otherwise New in PyTango 7.1.2
push_archive_event (self, attr_name, except) -> None
push_archive_event (self, attr_name, data, dim_x = 1, dim_y = 0) -> None
push_archive_event (self, attr_name, str_data, data) -> None
push_archive_event (self, attr_name, data, time_stamp, quality, dim_x = 1, dim_y = 0) -> None
push_archive_event (self, attr_name, str_data, data, time_stamp, quality) -> None
Push an archive event for the given attribute name. The event is pushed to the notification daemon.
Parameters:
attr_name: (str) attribute name data: the data to be sent as attribute event data. 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 str_data: (str) special variation for DevEncoded data type. In this case ‘data’ must be a str or an object with the buffer interface. except: (DevFailed) Instead of data, you may want to send an exception. dim_x: (int) the attribute x length. Default value is 1 dim_y: (int) the attribute y length. Default value is 0 time_stamp: (double) the time stamp quality: (AttrQuality) the attribute quality factor Throws: DevFailed If the attribute data type is not coherent.
Push an attribute configuration event.
Parameters: (Attribute) the attribute for which the configuration event will be sent. Return: None New in PyTango 7.2.1
push_change_event (self, attr_name, except) -> None
push_change_event (self, attr_name, data, dim_x = 1, dim_y = 0) -> None
push_change_event (self, attr_name, str_data, data) -> None
push_change_event (self, attr_name, data, time_stamp, quality, dim_x = 1, dim_y = 0) -> None
push_change_event (self, attr_name, str_data, data, time_stamp, quality) -> None
Push a change event for the given attribute name. The event is pushed to the notification daemon.
Parameters:
attr_name: (str) attribute name data: the data to be sent as attribute event data. 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 str_data: (str) special variation for DevEncoded data type. In this case ‘data’ must be a str or an object with the buffer interface. except: (DevFailed) Instead of data, you may want to send an exception. dim_x: (int) the attribute x length. Default value is 1 dim_y: (int) the attribute y length. Default value is 0 time_stamp: (double) the time stamp quality: (AttrQuality) the attribute quality factor Throws: DevFailed If the attribute data type is not coherent.
Push a data ready event for the given attribute name. The event is pushed to the notification daemon.
The method needs only the attribue name and an optional “counter” which will be passed unchanged within the event
Parameters:
attr_name: (str) attribute name counter: (int) the user counter Return: None
Throws: DevFailed If the attribute name is unknown.
push_event (self, attr_name, filt_names, filt_vals, data, dim_x = 1, dim_y = 0) -> None
push_event (self, attr_name, filt_names, filt_vals, str_data, data) -> None
push_event (self, attr_name, filt_names, filt_vals, data, time_stamp, quality, dim_x = 1, dim_y = 0) -> None
push_event (self, attr_name, filt_names, filt_vals, str_data, data, time_stamp, quality) -> None
Push a user event for the given attribute name. The event is pushed to the notification daemon.
Parameters:
attr_name: (str) attribute name filt_names: (sequence<str>) the filterable fields name filt_vals: (sequence<double>) the filterable fields value data: the data to be sent as attribute event data. 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 str_data: (str) special variation for DevEncoded data type. In this case ‘data’ must be a str or an object with the buffer interface. dim_x: (int) the attribute x length. Default value is 1 dim_y: (int) the attribute y length. Default value is 0 time_stamp: (double) the time stamp quality: (AttrQuality) the attribute quality factor Throws: DevFailed If the attribute data type is not coherent.
Register a signal. Register this device as device to be informed when signal signo is sent to to the device server process
Parameters:
signo: (int) signal identifier Return: None
Remove one attribute from the device attribute list.
Parameters : |
|
||
---|---|---|---|
Return : | None |
||
Throws : |
Set an implemented flag for the attribute to indicate that the server fires archive events manually, without the polling to be started. If the detect parameter is set to true, the criteria specified for the archive event are verified and the event is only pushed if they are fullfilled. If detect is set to false the event is fired without any value checking!
Parameters:
attr_name: (str) attribute name implemented: (bool) True when the server fires change events manually. detect: (bool) Triggers the verification of the change event properties when set to true. Default value is true. Return: None
Set an implemented flag for the attribute to indicate that the server fires change events manually, without the polling to be started. If the detect parameter is set to true, the criteria specified for the change event are verified and the event is only pushed if they are fullfilled. If detect is set to false the event is fired without any value checking!
Parameters:
attr_name: (str) attribute name implemented: (bool) True when the server fires change events manually. detect: (bool) Triggers the verification of the change event properties when set to true. Default value is true. Return: None
Set device state.
Parameters:
new_state: (DevState) the new device state Return: None
Set device status.
Parameters:
new_status: (str) the new device status Return: None
stop_polling (self, with_db_upd) -> None
Stop all polling for a device. if the device is polled, call this method before deleting it.
Parameters:
with_db_upd: (bool) Is it necessary to update db ? Return: None
New in PyTango 7.1.2
Bases: PyTango._PyTango.Device_2Impl
Add a new attribute to the device attribute list. Please, note that if you add an attribute to a device at device creation time, this attribute will be added to the device class attribute list. Therefore, all devices belonging to the same class created after this attribute addition will also have this attribute.
Parameters : |
|
||||||||
---|---|---|---|---|---|---|---|---|---|
Return : | (Attr) the newly created attribute. |
||||||||
Throws : |
Hook method. Default method to implement an action necessary on a device before any command is executed. This method can be redefined in sub-classes in case of the default behaviour does not fullfill the needs
Parameters: None Return: None Throws: DevFailed This method does not throw exception but a redefined method can.
Appends a string to the device status.
Parameters: status : (str) the string to be appened to the device status new_line : (bool) If true, appends a new line character before the string. Default is False Return: None
This method check that a command is supported by the device and does not need input value. The method throws an exception if the command is not defined or needs an input value
Parameters:
cmd_name: (str) the command name Return: None
Throws: DevFailed API_IncompatibleCmdArgumentType, API_CommandNotFound
New in PyTango 7.1.2
Sends the given message to the tango debug stream.
Since PyTango 7.1.3, the same can be achieved with:
print(msg, file=self.log_debug)
Parameters : |
|
||
---|---|---|---|
Return : | None |
Get device state. Default method to get device state. The behaviour of this method depends on the device state. If the device state is ON or ALARM, it reads the attribute(s) with an alarm level defined, check if the read value is above/below the alarm and eventually change the state to ALARM, return the device state. For all th other device state, this method simply returns the state This method can be redefined in sub-classes in case of the default behaviour does not fullfill the needs.
Parameters: None Return: (DevState) the device state Throws: DevFailed - If it is necessary to read attribute(s) and a problem occurs during the reading
Get device status. Default method to get device status. It returns the contents of the device dev_status field. If the device state is ALARM, alarm messages are added to the device status. This method can be redefined in sub-classes in case of the default behaviour does not fullfill the needs.
Parameters: None Return: (str) the device status Throws: DevFailed - If it is necessary to read attribute(s) and a problem occurs during the reading
Sends the given message to the tango error stream.
Since PyTango 7.1.3, the same can be achieved with:
print(msg, file=self.log_error)
Parameters : |
|
||
---|---|---|---|
Return : | None |
Sends the given message to the tango fatal stream.
Since PyTango 7.1.3, the same can be achieved with:
print(msg, file=self.log_fatal)
Parameters : |
|
||
---|---|---|---|
Return : | None |
Returns the min attribute poll period
Parameters: None Return: (seq) the min attribute poll period New in PyTango 7.2.0
Returns the min command poll period
Parameters: None Return: (seq) the min command poll period New in PyTango 7.2.0
Get device multi attribute object.
Parameters: None Return: (MultiAttribute) the device’s MultiAttribute object
Utility method that fetches all the device properties from the database and converts them into members of this DeviceImpl.
Parameters : |
|
||
---|---|---|---|
Return : | None |
||
Throws : |
Returns the state of the exported flag
Parameters: None Return: (bool) the state of the exported flag New in PyTango 7.1.2
Returns the Logger object for this device
Parameters: None Return: (Logger) the Logger object for this device
Get a COPY of the device name.
Parameters: None Return: (str) the device name
Returns a COPY of the list of non automatic polled attributes
Parameters: None Return: (sequence<str>) a COPY of the list of non automatic polled attributes New in PyTango 7.1.2
Returns a COPY of the list of non automatic polled commands
Parameters: None Return: (sequence<str>) a COPY of the list of non automatic polled commands New in PyTango 7.1.2
Returns a COPY of the list of polled attributes
Parameters: None Return: (sequence<str>) a COPY of the list of polled attributes New in PyTango 7.1.2
Returns a COPY of the list of polled commands
Parameters: None Return: (sequence<str>) a COPY of the list of polled commands New in PyTango 7.1.2
Get a COPY of the device’s previous state.
Parameters: None Return: (DevState) the device’s previous state
Get a COPY of the device state.
Parameters: None Return: (DevState) Current device state
Get a COPY of the device status.
Parameters: None Return: (str) the device status
Sends the given message to the tango info stream.
Since PyTango 7.1.3, the same can be achieved with:
print(msg, file=self.log_info)
Parameters : |
|
||
---|---|---|---|
Return : | None |
Returns if this device is locked by a client
Parameters: None Return: (bool) True if it is locked or False otherwise New in PyTango 7.1.2
Returns if it is polled
Parameters: None Return: (bool) True if it is polled or False otherwise New in PyTango 7.1.2
push_archive_event (self, attr_name, except) -> None
push_archive_event (self, attr_name, data, dim_x = 1, dim_y = 0) -> None
push_archive_event (self, attr_name, str_data, data) -> None
push_archive_event (self, attr_name, data, time_stamp, quality, dim_x = 1, dim_y = 0) -> None
push_archive_event (self, attr_name, str_data, data, time_stamp, quality) -> None
Push an archive event for the given attribute name. The event is pushed to the notification daemon.
Parameters:
attr_name: (str) attribute name data: the data to be sent as attribute event data. 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 str_data: (str) special variation for DevEncoded data type. In this case ‘data’ must be a str or an object with the buffer interface. except: (DevFailed) Instead of data, you may want to send an exception. dim_x: (int) the attribute x length. Default value is 1 dim_y: (int) the attribute y length. Default value is 0 time_stamp: (double) the time stamp quality: (AttrQuality) the attribute quality factor Throws: DevFailed If the attribute data type is not coherent.
Push an attribute configuration event.
Parameters: (Attribute) the attribute for which the configuration event will be sent. Return: None New in PyTango 7.2.1
push_change_event (self, attr_name, except) -> None
push_change_event (self, attr_name, data, dim_x = 1, dim_y = 0) -> None
push_change_event (self, attr_name, str_data, data) -> None
push_change_event (self, attr_name, data, time_stamp, quality, dim_x = 1, dim_y = 0) -> None
push_change_event (self, attr_name, str_data, data, time_stamp, quality) -> None
Push a change event for the given attribute name. The event is pushed to the notification daemon.
Parameters:
attr_name: (str) attribute name data: the data to be sent as attribute event data. 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 str_data: (str) special variation for DevEncoded data type. In this case ‘data’ must be a str or an object with the buffer interface. except: (DevFailed) Instead of data, you may want to send an exception. dim_x: (int) the attribute x length. Default value is 1 dim_y: (int) the attribute y length. Default value is 0 time_stamp: (double) the time stamp quality: (AttrQuality) the attribute quality factor Throws: DevFailed If the attribute data type is not coherent.
Push a data ready event for the given attribute name. The event is pushed to the notification daemon.
The method needs only the attribue name and an optional “counter” which will be passed unchanged within the event
Parameters:
attr_name: (str) attribute name counter: (int) the user counter Return: None
Throws: DevFailed If the attribute name is unknown.
push_event (self, attr_name, filt_names, filt_vals, data, dim_x = 1, dim_y = 0) -> None
push_event (self, attr_name, filt_names, filt_vals, str_data, data) -> None
push_event (self, attr_name, filt_names, filt_vals, data, time_stamp, quality, dim_x = 1, dim_y = 0) -> None
push_event (self, attr_name, filt_names, filt_vals, str_data, data, time_stamp, quality) -> None
Push a user event for the given attribute name. The event is pushed to the notification daemon.
Parameters:
attr_name: (str) attribute name filt_names: (sequence<str>) the filterable fields name filt_vals: (sequence<double>) the filterable fields value data: the data to be sent as attribute event data. 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 str_data: (str) special variation for DevEncoded data type. In this case ‘data’ must be a str or an object with the buffer interface. dim_x: (int) the attribute x length. Default value is 1 dim_y: (int) the attribute y length. Default value is 0 time_stamp: (double) the time stamp quality: (AttrQuality) the attribute quality factor Throws: DevFailed If the attribute data type is not coherent.
Read the hardware to return attribute value(s). Default method to implement an action necessary on a device to read the hardware involved in a a read attribute CORBA call. This method must be redefined in sub-classes in order to support attribute reading
Parameters:
- attr_list : (sequence<int>) list of indices in the device object attribute vector
of an attribute to be read.
Return: None
Throws: DevFailed This method does not throw exception but a redefined method can.
Register a signal. Register this device as device to be informed when signal signo is sent to to the device server process
Parameters:
signo: (int) signal identifier Return: None
Remove one attribute from the device attribute list.
Parameters : |
|
||
---|---|---|---|
Return : | None |
||
Throws : |
Set an implemented flag for the attribute to indicate that the server fires archive events manually, without the polling to be started. If the detect parameter is set to true, the criteria specified for the archive event are verified and the event is only pushed if they are fullfilled. If detect is set to false the event is fired without any value checking!
Parameters:
attr_name: (str) attribute name implemented: (bool) True when the server fires change events manually. detect: (bool) Triggers the verification of the change event properties when set to true. Default value is true. Return: None
Set an implemented flag for the attribute to indicate that the server fires change events manually, without the polling to be started. If the detect parameter is set to true, the criteria specified for the change event are verified and the event is only pushed if they are fullfilled. If detect is set to false the event is fired without any value checking!
Parameters:
attr_name: (str) attribute name implemented: (bool) True when the server fires change events manually. detect: (bool) Triggers the verification of the change event properties when set to true. Default value is true. Return: None
Set device state.
Parameters:
new_state: (DevState) the new device state Return: None
Set device status.
Parameters:
new_status: (str) the new device status Return: None
Signal handler. The method executed when the signal arrived in the device server process. This method is defined as virtual and then, can be redefined following device needs.
Parameters:
signo: (int) the signal number Return: None
Throws: DevFailed This method does not throw exception but a redefined method can.
stop_polling (self, with_db_upd) -> None
Stop all polling for a device. if the device is polled, call this method before deleting it.
Parameters:
with_db_upd: (bool) Is it necessary to update db ? Return: None
New in PyTango 7.1.2
Unregister a signal. Unregister this device as device to be informed when signal signo is sent to to the device server process
Parameters:
signo: (int) signal identifier Return: None
Sends the given message to the tango warn stream.
Since PyTango 7.1.3, the same can be achieved with:
print(msg, file=self.log_warn)
Parameters : |
|
||
---|---|---|---|
Return : | None |
Write the hardware for attributes. Default method to implement an action necessary on a device to write the hardware involved in a a write attribute. This method must be redefined in sub-classes in order to support writable attribute
Parameters:
- attr_list : (sequence<int>) list of indices in the device object attribute vector
of an attribute to be written.
Return: None
Throws: DevFailed This method does not throw exception but a redefined method can.
Bases: PyTango._PyTango.Device_3Impl
Add a new attribute to the device attribute list. Please, note that if you add an attribute to a device at device creation time, this attribute will be added to the device class attribute list. Therefore, all devices belonging to the same class created after this attribute addition will also have this attribute.
Parameters : |
|
||||||||
---|---|---|---|---|---|---|---|---|---|
Return : | (Attr) the newly created attribute. |
||||||||
Throws : |
Hook method. Default method to implement an action necessary on a device before any command is executed. This method can be redefined in sub-classes in case of the default behaviour does not fullfill the needs
Parameters: None Return: None Throws: DevFailed This method does not throw exception but a redefined method can.
Appends a string to the device status.
Parameters: status : (str) the string to be appened to the device status new_line : (bool) If true, appends a new line character before the string. Default is False Return: None
This method check that a command is supported by the device and does not need input value. The method throws an exception if the command is not defined or needs an input value
Parameters:
cmd_name: (str) the command name Return: None
Throws: DevFailed API_IncompatibleCmdArgumentType, API_CommandNotFound
New in PyTango 7.1.2
Sends the given message to the tango debug stream.
Since PyTango 7.1.3, the same can be achieved with:
print(msg, file=self.log_debug)
Parameters : |
|
||
---|---|---|---|
Return : | None |
Get device state. Default method to get device state. The behaviour of this method depends on the device state. If the device state is ON or ALARM, it reads the attribute(s) with an alarm level defined, check if the read value is above/below the alarm and eventually change the state to ALARM, return the device state. For all th other device state, this method simply returns the state This method can be redefined in sub-classes in case of the default behaviour does not fullfill the needs.
Parameters: None Return: (DevState) the device state Throws: DevFailed - If it is necessary to read attribute(s) and a problem occurs during the reading
Get device status. Default method to get device status. It returns the contents of the device dev_status field. If the device state is ALARM, alarm messages are added to the device status. This method can be redefined in sub-classes in case of the default behaviour does not fullfill the needs.
Parameters: None Return: (str) the device status Throws: DevFailed - If it is necessary to read attribute(s) and a problem occurs during the reading
Sends the given message to the tango error stream.
Since PyTango 7.1.3, the same can be achieved with:
print(msg, file=self.log_error)
Parameters : |
|
||
---|---|---|---|
Return : | None |
Sends the given message to the tango fatal stream.
Since PyTango 7.1.3, the same can be achieved with:
print(msg, file=self.log_fatal)
Parameters : |
|
||
---|---|---|---|
Return : | None |
Returns the min attribute poll period
Parameters: None Return: (seq) the min attribute poll period New in PyTango 7.2.0
Returns the min command poll period
Parameters: None Return: (seq) the min command poll period New in PyTango 7.2.0
Get device multi attribute object.
Parameters: None Return: (MultiAttribute) the device’s MultiAttribute object
Utility method that fetches all the device properties from the database and converts them into members of this DeviceImpl.
Parameters : |
|
||
---|---|---|---|
Return : | None |
||
Throws : |
Returns the state of the exported flag
Parameters: None Return: (bool) the state of the exported flag New in PyTango 7.1.2
Returns the Logger object for this device
Parameters: None Return: (Logger) the Logger object for this device
Get a COPY of the device name.
Parameters: None Return: (str) the device name
Returns a COPY of the list of non automatic polled attributes
Parameters: None Return: (sequence<str>) a COPY of the list of non automatic polled attributes New in PyTango 7.1.2
Returns a COPY of the list of non automatic polled commands
Parameters: None Return: (sequence<str>) a COPY of the list of non automatic polled commands New in PyTango 7.1.2
Returns a COPY of the list of polled attributes
Parameters: None Return: (sequence<str>) a COPY of the list of polled attributes New in PyTango 7.1.2
Returns a COPY of the list of polled commands
Parameters: None Return: (sequence<str>) a COPY of the list of polled commands New in PyTango 7.1.2
Get a COPY of the device’s previous state.
Parameters: None Return: (DevState) the device’s previous state
Get a COPY of the device state.
Parameters: None Return: (DevState) Current device state
Get a COPY of the device status.
Parameters: None Return: (str) the device status
Sends the given message to the tango info stream.
Since PyTango 7.1.3, the same can be achieved with:
print(msg, file=self.log_info)
Parameters : |
|
||
---|---|---|---|
Return : | None |
Returns if this device is locked by a client
Parameters: None Return: (bool) True if it is locked or False otherwise New in PyTango 7.1.2
Returns if it is polled
Parameters: None Return: (bool) True if it is polled or False otherwise New in PyTango 7.1.2
push_archive_event (self, attr_name, except) -> None
push_archive_event (self, attr_name, data, dim_x = 1, dim_y = 0) -> None
push_archive_event (self, attr_name, str_data, data) -> None
push_archive_event (self, attr_name, data, time_stamp, quality, dim_x = 1, dim_y = 0) -> None
push_archive_event (self, attr_name, str_data, data, time_stamp, quality) -> None
Push an archive event for the given attribute name. The event is pushed to the notification daemon.
Parameters:
attr_name: (str) attribute name data: the data to be sent as attribute event data. 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 str_data: (str) special variation for DevEncoded data type. In this case ‘data’ must be a str or an object with the buffer interface. except: (DevFailed) Instead of data, you may want to send an exception. dim_x: (int) the attribute x length. Default value is 1 dim_y: (int) the attribute y length. Default value is 0 time_stamp: (double) the time stamp quality: (AttrQuality) the attribute quality factor Throws: DevFailed If the attribute data type is not coherent.
Push an attribute configuration event.
Parameters: (Attribute) the attribute for which the configuration event will be sent. Return: None New in PyTango 7.2.1
push_change_event (self, attr_name, except) -> None
push_change_event (self, attr_name, data, dim_x = 1, dim_y = 0) -> None
push_change_event (self, attr_name, str_data, data) -> None
push_change_event (self, attr_name, data, time_stamp, quality, dim_x = 1, dim_y = 0) -> None
push_change_event (self, attr_name, str_data, data, time_stamp, quality) -> None
Push a change event for the given attribute name. The event is pushed to the notification daemon.
Parameters:
attr_name: (str) attribute name data: the data to be sent as attribute event data. 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 str_data: (str) special variation for DevEncoded data type. In this case ‘data’ must be a str or an object with the buffer interface. except: (DevFailed) Instead of data, you may want to send an exception. dim_x: (int) the attribute x length. Default value is 1 dim_y: (int) the attribute y length. Default value is 0 time_stamp: (double) the time stamp quality: (AttrQuality) the attribute quality factor Throws: DevFailed If the attribute data type is not coherent.
Push a data ready event for the given attribute name. The event is pushed to the notification daemon.
The method needs only the attribue name and an optional “counter” which will be passed unchanged within the event
Parameters:
attr_name: (str) attribute name counter: (int) the user counter Return: None
Throws: DevFailed If the attribute name is unknown.
push_event (self, attr_name, filt_names, filt_vals, data, dim_x = 1, dim_y = 0) -> None
push_event (self, attr_name, filt_names, filt_vals, str_data, data) -> None
push_event (self, attr_name, filt_names, filt_vals, data, time_stamp, quality, dim_x = 1, dim_y = 0) -> None
push_event (self, attr_name, filt_names, filt_vals, str_data, data, time_stamp, quality) -> None
Push a user event for the given attribute name. The event is pushed to the notification daemon.
Parameters:
attr_name: (str) attribute name filt_names: (sequence<str>) the filterable fields name filt_vals: (sequence<double>) the filterable fields value data: the data to be sent as attribute event data. 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 str_data: (str) special variation for DevEncoded data type. In this case ‘data’ must be a str or an object with the buffer interface. dim_x: (int) the attribute x length. Default value is 1 dim_y: (int) the attribute y length. Default value is 0 time_stamp: (double) the time stamp quality: (AttrQuality) the attribute quality factor Throws: DevFailed If the attribute data type is not coherent.
Read the hardware to return attribute value(s). Default method to implement an action necessary on a device to read the hardware involved in a a read attribute CORBA call. This method must be redefined in sub-classes in order to support attribute reading
Parameters:
- attr_list : (sequence<int>) list of indices in the device object attribute vector
of an attribute to be read.
Return: None
Throws: DevFailed This method does not throw exception but a redefined method can.
Register a signal. Register this device as device to be informed when signal signo is sent to to the device server process
Parameters:
signo: (int) signal identifier Return: None
Remove one attribute from the device attribute list.
Parameters : |
|
||
---|---|---|---|
Return : | None |
||
Throws : |
Set an implemented flag for the attribute to indicate that the server fires archive events manually, without the polling to be started. If the detect parameter is set to true, the criteria specified for the archive event are verified and the event is only pushed if they are fullfilled. If detect is set to false the event is fired without any value checking!
Parameters:
attr_name: (str) attribute name implemented: (bool) True when the server fires change events manually. detect: (bool) Triggers the verification of the change event properties when set to true. Default value is true. Return: None
Set an implemented flag for the attribute to indicate that the server fires change events manually, without the polling to be started. If the detect parameter is set to true, the criteria specified for the change event are verified and the event is only pushed if they are fullfilled. If detect is set to false the event is fired without any value checking!
Parameters:
attr_name: (str) attribute name implemented: (bool) True when the server fires change events manually. detect: (bool) Triggers the verification of the change event properties when set to true. Default value is true. Return: None
Set device state.
Parameters:
new_state: (DevState) the new device state Return: None
Set device status.
Parameters:
new_status: (str) the new device status Return: None
Signal handler. The method executed when the signal arrived in the device server process. This method is defined as virtual and then, can be redefined following device needs.
Parameters:
signo: (int) the signal number Return: None
Throws: DevFailed This method does not throw exception but a redefined method can.
stop_polling (self, with_db_upd) -> None
Stop all polling for a device. if the device is polled, call this method before deleting it.
Parameters:
with_db_upd: (bool) Is it necessary to update db ? Return: None
New in PyTango 7.1.2
Unregister a signal. Unregister this device as device to be informed when signal signo is sent to to the device server process
Parameters:
signo: (int) signal identifier Return: None
Sends the given message to the tango warn stream.
Since PyTango 7.1.3, the same can be achieved with:
print(msg, file=self.log_warn)
Parameters : |
|
||
---|---|---|---|
Return : | None |
Write the hardware for attributes. Default method to implement an action necessary on a device to write the hardware involved in a a write attribute. This method must be redefined in sub-classes in order to support writable attribute
Parameters:
- attr_list : (sequence<int>) list of indices in the device object attribute vector
of an attribute to be written.
Return: None
Throws: DevFailed This method does not throw exception but a redefined method can.