taurusdmslabel.TaurusDmsLabel Class Reference

DMS label implementation that uses Taurus to get the Radian value of set datapoint URI and convert it to a DMS value. More...

Inheritance diagram for taurusdmslabel.TaurusDmsLabel:

Public Member Functions
def	__init__ (self, parent=None)
	Class Magic Methods ###.
def	setHandleEventBlocker (self, bool value)
def	controller (self)
def	controllerUpdate (self)
def	handleEvent (self, evt_src, evt_type, evt_value)
	Overwritting Taurus Methods ###.
def	isReadOnly (self)
	Overrides TaurusBaseComponent.isReadOnly method.
def	setModel (self, uri, index)
	Setter for model property, which is the URI to the datapoint tobe read This should point to a Taurus Model that is an array or a single value datapoint.
def	getModelIndexValue (self)
	Overwritting QT Methods ###.
def	getBgRole (self)
def	setBgRole (self, bgRole)
	Set the background role.
def	resetBgRole (self)
	Reset the background role to its default value.
def	getFgRole (self)
def	setFgRole (self, fgRole)
	Set what is shown as the foreground (the text) of the label Valid Roles are:
def	resetFgRole (self)
	Reset the foreground role to its default value.

Static Public Attributes
Qt	model
	Defining QT Properties ###.
Qt	fgRole
Qt	bgRole

Protected Member Functions
def	_calculate_controller_class (self)
	Overwritting Controlling Methods ###.

Protected Attributes
	_bgRole
	_fgRole
	_blocked
	_modelIndex
	_controller

Detailed Description

DMS label implementation that uses Taurus to get the Radian value of set datapoint URI and convert it to a DMS value.

Constructor & Destructor Documentation

__init__()

def taurusdmslabel.TaurusDmsLabel.__init__	(		self,
			parent = None
	)

Class Magic Methods ###.

Initializer for TaurusDmsLabel

Parameters

parent

Widget that holds this TaurusDmsLabel instance

Member Function Documentation

_calculate_controller_class()

def taurusdmslabel.TaurusDmsLabel._calculate_controller_class (   self )

protected

Overwritting Controlling Methods ###.

controller()

def taurusdmslabel.TaurusDmsLabel.controller

(

self

)

controllerUpdate()

def taurusdmslabel.TaurusDmsLabel.controllerUpdate

(

self

)

getBgRole()

def taurusdmslabel.TaurusDmsLabel.getBgRole

(

self

)

getFgRole()

def taurusdmslabel.TaurusDmsLabel.getFgRole

(

self

)

getModelIndexValue()

def taurusdmslabel.TaurusDmsLabel.getModelIndexValue

(

self

)

Overwritting QT Methods ###.

handleEvent()

def taurusdmslabel.TaurusDmsLabel.handleEvent	(		self,
			evt_src,
			evt_type,
			evt_value
	)

Overwritting Taurus Methods ###.

Overrides TaurusBaseComponent.handleEvent method. Grab the the event value and based on the index set the radians values to be converted by the QeDmsLabel

Parameters

evt_src	Name of the Attribute that generates the event
evt_type	Type of Event according to taurus.core.taurusbasetypes.TaurusEventType
evt_value	Value of the event

isReadOnly()

def taurusdmslabel.TaurusDmsLabel.isReadOnly

(

self

)

Overrides TaurusBaseComponent.isReadOnly method.

Indicates that the widget is a read only widget.

Returns

True

resetBgRole()

def taurusdmslabel.TaurusDmsLabel.resetBgRole

(

self

)

Reset the background role to its default value.

resetFgRole()

def taurusdmslabel.TaurusDmsLabel.resetFgRole

(

self

)

Reset the foreground role to its default value.

setBgRole()

def taurusdmslabel.TaurusDmsLabel.setBgRole	(		self,
			bgRole
	)

Set the background role.

The label background will be set according to the current palette and the role. Valid roles are:

• 'none' : no background
• 'state' a color depending on the device state
• 'quality' a color depending on the attribute quality
• 'rvalue' a color depending on the rvalue of the attribute
• <arbitrary member name> a color based on the value of an arbitrary member of the model object (warning: experimental feature!)

.. warning:: the <arbitrary member name> support is still experimental and its API may change in future versions

setFgRole()

def taurusdmslabel.TaurusDmsLabel.setFgRole	(		self,
			fgRole
	)

Set what is shown as the foreground (the text) of the label Valid Roles are:

• 'rvalue' the read value of the attribute
• 'wvalue' the write value of the attribute
• 'none' : no text
• 'quality' - the quality of the attribute is displayed
• 'state' - the device state

setHandleEventBlocker()

def taurusdmslabel.TaurusDmsLabel.setHandleEventBlocker	(		self,
		bool	value
	)

setModel()

def taurusdmslabel.TaurusDmsLabel.setModel	(		self,
			uri,
			index
	)

Setter for model property, which is the URI to the datapoint tobe read This should point to a Taurus Model that is an array or a single value datapoint.

Parameters

uri	String that contains a URI for the Taurus Model.
index	Element number to be read in case it is an array datapoint value.

Member Data Documentation

_bgRole

taurusdmslabel.TaurusDmsLabel._bgRole

protected

_blocked

taurusdmslabel.TaurusDmsLabel._blocked

protected

_controller

taurusdmslabel.TaurusDmsLabel._controller

protected

_fgRole

taurusdmslabel.TaurusDmsLabel._fgRole

protected

_modelIndex

taurusdmslabel.TaurusDmsLabel._modelIndex

protected

bgRole

Qt taurusdmslabel.TaurusDmsLabel.bgRole

static

Initial value:

=  Qt.pyqtProperty(
        "QString", getBgRole, setBgRole, resetBgRole, doc="background role"
    )

fgRole

Qt taurusdmslabel.TaurusDmsLabel.fgRole

static

Initial value:

=  Qt.pyqtProperty(
        "QString", getFgRole, setFgRole, resetFgRole, doc="foreground role"
    )

model

Qt taurusdmslabel.TaurusDmsLabel.model

static

Initial value:

=  Qt.pyqtProperty(
        "QString", TaurusBaseWidget.getModel, setModel, TaurusBaseWidget.resetModel
    )

Defining QT Properties ###.

---

The documentation for this class was generated from the following file:

• telsimui/src/hlcc/telsimui/widgets/taurus/taurusdmslabel.py