hlcc 2.0.0-beta2+pre1
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
taurusdegreeslabel.TaurusDegreesLabel Class Reference

Degrees label implementation that uses Taurus to get the Degrees value of set datapoint URI and display it. More...

Inheritance diagram for taurusdegreeslabel.TaurusDegreesLabel:

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
 
 _degrees_value
 

Detailed Description

Degrees label implementation that uses Taurus to get the Degrees value of set datapoint URI and display it.

Constructor & Destructor Documentation

◆ __init__()

def taurusdegreeslabel.TaurusDegreesLabel.__init__ (   self,
  parent = None 
)

Class Magic Methods ###.

Initializer for TaurusHmsLabel

Parameters
parentWidget that holds this TaurusHmsLabel instance

Member Function Documentation

◆ _calculate_controller_class()

def taurusdegreeslabel.TaurusDegreesLabel._calculate_controller_class (   self)
protected

Overwritting Controlling Methods ###.

◆ controller()

def taurusdegreeslabel.TaurusDegreesLabel.controller (   self)

◆ controllerUpdate()

def taurusdegreeslabel.TaurusDegreesLabel.controllerUpdate (   self)

◆ getBgRole()

def taurusdegreeslabel.TaurusDegreesLabel.getBgRole (   self)

◆ getFgRole()

def taurusdegreeslabel.TaurusDegreesLabel.getFgRole (   self)

◆ getModelIndexValue()

def taurusdegreeslabel.TaurusDegreesLabel.getModelIndexValue (   self)

Overwritting QT Methods ###.

◆ handleEvent()

def taurusdegreeslabel.TaurusDegreesLabel.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 QeHmsLabel

Parameters
evt_srcName of the Attribute that generates the event
evt_typeType of Event according to taurus.core.taurusbasetypes.TaurusEventType
evt_valueValue of the event

◆ isReadOnly()

def taurusdegreeslabel.TaurusDegreesLabel.isReadOnly (   self)

Overrides TaurusBaseComponent.isReadOnly method.

Indicates that the widget is a read only widget.

Returns
True

◆ resetBgRole()

def taurusdegreeslabel.TaurusDegreesLabel.resetBgRole (   self)

Reset the background role to its default value.

◆ resetFgRole()

def taurusdegreeslabel.TaurusDegreesLabel.resetFgRole (   self)

Reset the foreground role to its default value.

◆ setBgRole()

def taurusdegreeslabel.TaurusDegreesLabel.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 taurusdegreeslabel.TaurusDegreesLabel.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 taurusdegreeslabel.TaurusDegreesLabel.setHandleEventBlocker (   self,
bool  value 
)

◆ setModel()

def taurusdegreeslabel.TaurusDegreesLabel.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
uriString that contains a URI for the Taurus Model.
indexElement number to be read in case it is an array datapoint value.

Member Data Documentation

◆ _bgRole

taurusdegreeslabel.TaurusDegreesLabel._bgRole
protected

◆ _blocked

taurusdegreeslabel.TaurusDegreesLabel._blocked
protected

◆ _controller

taurusdegreeslabel.TaurusDegreesLabel._controller
protected

◆ _degrees_value

taurusdegreeslabel.TaurusDegreesLabel._degrees_value
protected

◆ _fgRole

taurusdegreeslabel.TaurusDegreesLabel._fgRole
protected

◆ _modelIndex

taurusdegreeslabel.TaurusDegreesLabel._modelIndex
protected

◆ bgRole

Qt taurusdegreeslabel.TaurusDegreesLabel.bgRole
static
Initial value:
= Qt.pyqtProperty(
"QString", getBgRole, setBgRole, resetBgRole, doc="background role"
)

◆ fgRole

Qt taurusdegreeslabel.TaurusDegreesLabel.fgRole
static
Initial value:
= Qt.pyqtProperty(
"QString", getFgRole, setFgRole, resetFgRole, doc="foreground role"
)

◆ model

Qt taurusdegreeslabel.TaurusDegreesLabel.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: