cut 3.3.0
Loading...
Searching...
No Matches
taurus.taurusdartboard.TaurusDartBoard Class Reference

Taurus based widget for QeDartBoard, capable of connecting through taurus plugins to control system and services. More...

Inheritance diagram for taurus.taurusdartboard.TaurusDartBoard:
QeDartBoard QeRadialItemPlot

Public Member Functions

 __init__ (self, Qt.QWidget parent=None, designMode=False)
 Initializes the object with defaults values, and obtains the appropiate controller.
 
TaurusBaseController controller (self)
 Returns the controller object for this widget.
 
 isReadOnly (self)
 This widget is only capable of displaying data, but not writing.
 
 setModel (self, str m)
 Setter for the model property.
 
 getModelIndexValue (self)
 Gets the value of the modelIndex property.
 
 getModelIndex (self)
 Getter for the modelIndex property.
 
 setModelIndex (self, modelIndex)
 Getter for the modelIndex property.
 
 resetModelIndex (self)
 Getter for the bgRole property.
 
 getBgRole (self)
 Getter for the bgRole property.
 
 setBgRole (self, str bgRole)
 Setter for the bgRole property.
 
 resetBgRole (self)
 Resets to the default value the bgRole property.
 
 getFgRole (self)
 Getter for the fgRole property.
 
 setFgRole (self, str fgRole)
 Setter for the fgRole property.
 
 resetFgRole (self)
 Resets to the default value the fgRole property.
 
 getQtDesignerPluginInfo (cls)
 Provides Qt Designer with widget information.
 
- Public Member Functions inherited from QeDartBoard
 QeDartBoard (QWidget *parent=Q_NULLPTR)
 Constructor that is used to set a parent relationship with.
 
double getCurrentAlt ()
 Gets the value of the current altitude the widget has.
 
double getCurrentAz ()
 Gets the value of the current azimuth the widget has.
 
double getTargetAlt ()
 Gets the value of the target altitude the widget has.
 
double getTargetAz ()
 Gets the value of the target azimuth the widget has.
 
double getTelescopeLat ()
 Gets the value of the telescope latitude the widget has.
 
double getTelescopeLong ()
 Gets the value of the telescope longitude the widget has.
 
double getWindDirection ()
 Gets the value of the wind direction the widget has.
 
- Public Member Functions inherited from QeRadialItemPlot
 QeRadialItemPlot (QWidget *parent=Q_NULLPTR)
 Constructor that is used to set a parent relationship with.
 
bool getIsClockwise ()
 Gets the value the flag that determines if radial values change clockwise or counterclockwise.
 
bool getDegRadNumericDisplay ()
 Returns the true if using radians to display numerical values.
 
bool getShowGrid ()
 Returns the true if grid is displayed.
 
QPixmap getBackgroundPixmap ()
 Returns background QPixmap that is stored in unique ptr.
 

Static Public Attributes

 model = Qt.Property("QString", TaurusBaseWidget.getModel, setModel, TaurusBaseWidget.resetModel)
 This property holds the unique URI string representing the model name with which this widget will get its data from.
 
 modelIndex = Qt.Property("QString", getModelIndex, setModelIndex, resetModelIndex)
 This property holds the index inside the model value that should be displayed.
 
 fgRole = Qt.Property("QString", getFgRole, setFgRole, resetFgRole, doc="foreground role")
 This property holds the foreground role.
 
 bgRole = Qt.Property("QString", getBgRole, setBgRole, resetBgRole, doc="background role")
 This property holds the background role.
 

Additional Inherited Members

- Public Slots inherited from QeDartBoard
void setCurrentAlt (double newValue)
 Sets the value of the current altitude property.
 
void setCurrentAz (double newValue)
 Sets the value of the current azimuth property.
 
void setTargetAlt (double newValue)
 Sets the value of the target altitude property.
 
void setTargetAz (double newValue)
 Sets the value of the target azimuth property.
 
void setTelescopeLat (double newValue)
 Sets the value of the latitude of the telescope.
 
void setTelescopeLong (double newValue)
 Sets the value of the longitude of the telescope.
 
void setWindDirection (double newValue)
 Sets the value of the latitude of the telescope.
 
- Public Slots inherited from QeRadialItemPlot
void setIsClockwise (bool newValue)
 Changes the direction of radial values distribution.
 
void setDegRadNumericDisplay (bool newValue)
 Changes the units used to display the values.
 
void setShowGrid (bool newValue)
 Changes the grid visibility indicator.
 
void updateBackground ()
 Updates the m_backgroundUpdateNeeded internal flag to signal a significant change was detect, and the cache needs to be rebuild.
 
- Signals inherited from QeDartBoard
void currentAltChanged (double newValue)
 Indicates that the current altitude value has changed.
 
void currentAzChanged (double newValue)
 Indicates that the current azimuth value has changed.
 
void targetAltChanged (double newValue)
 Indicates that the target altitude value has changed.
 
void targetAzChanged (double newValue)
 Indicates that the target azimuth value has changed.
 
void telescopeLatChanged (double newValue)
 Indicates that telescope latitude has changed.
 
void telescopeLongChanged (double newValue)
 Indicates that telescope longitude has changed.
 
void windDirectionChanged (double newValue)
 Indicates that the wind direction has changed.
 
- Signals inherited from QeRadialItemPlot
void isClockwiseChanged (bool newValue)
 Indicates that the direction of values distribution chanegd.
 
void degRadNumericDisplayTriggered (bool newValue)
 Indicates that the numerical unit representation has changed.
 
void showGridChanged (bool newValue)
 Indicates that the numerical unit representation has changed.
 
- Protected Member Functions inherited from QeDartBoard
void paintEvent (QPaintEvent *event) override
 Overrides QWidget::paintEvent to implement its own rendering instructions.
 
void paintDartBoard (QPainter *painter) override
 Uses a QPainter to draw the dartboard (mostly static) background.
 
- Protected Member Functions inherited from QeRadialItemPlot
void changeEvent (QEvent *event) override
 Overrides QWidget::changeEvent to catch when certain QWidget's properties has changed.
 
void resizeEvent (QResizeEvent *event) override
 Overrides QWidget::resizeEvent to catch when the size has changed.
 
void cacheBackground (QPainter *painter)
 Stores in a pointer the new background cache.
 
void setDirectionIndicatorSigns (QString vertical, QString horizontal)
 Sets indicators' symbols for directions arrows painted in top right corner.
 
void setDirectionIndicatorVisible (bool isVisible)
 Sets directions indicator (painted in the top right corner of the widget) visible.
 
void drawValues (QPainter *painter)
 Draws numeric values around the radial plot in a desired direction (eiher clockwise or counterclockwise)
 
- Properties inherited from QeDartBoard
double currentAlt
 Altitude coordinate of the current position in radians.
 
double currentAz
 Azimuth coordinate of the current position in radians.
 
double targetAlt
 Altitude coordinate of the target position in radians.
 
double targetAz
 Azimuth coordinate of the target position in radians.
 
double telescopeLat
 Telescope Latitude position – currently not used.
 
double telescopeLong
 Telescope Longitude position – currently not used.
 
double windDirection
 Wind direction – currently not used.
 
- Properties inherited from QeRadialItemPlot
bool isClockwise
 Flag that determines if radial coordinates of the plot change clockwise (true) or counterclockwise (false) The property is true by default (clockwise)
 
bool degRadNumericDisplay
 Degrees/Radians numerical indicators representation (0 - Degrees, 1 - Radians)
 
bool showGrid
 Show/hide grid.
 

Detailed Description

Taurus based widget for QeDartBoard, capable of connecting through taurus plugins to control system and services.

Attention
To use this class, please import with the following statement:
from elt.cut.widgets.tuarus.taurusdartboard import TaurusDartBoard

The Dartboard is a custom widget that renders in radial coordinates the Altitude and Azimuth of two positions: the target, and the current.

Values in the radial axis range from Pi/2 radians at the center, to 0 at the outer border. Values in the angular axis start with 0 radians from the South position, and increase starting counter-clockwise up to 2*Pi radians.

The target is rendered in red, and the current position in blue.

See also
TaurusBaseWidget https://taurus-scada.org/devel/api/taurus.qt.qtgui.base-TaurusBaseWidget.html

Constructor & Destructor Documentation

◆ __init__()

taurus.taurusdartboard.TaurusDartBoard.__init__ ( self,
Qt.QWidget parent = None,
designMode = False )

Initializes the object with defaults values, and obtains the appropiate controller.

Parameters
parentParent Widget.
designModeIndicates if the widget is started within the Qt Designer

Member Function Documentation

◆ controller()

TaurusBaseController taurus.taurusdartboard.TaurusDartBoard.controller ( self)

Returns the controller object for this widget.

See also
TaurusBaseController
Returns
TaurusBaseController controller of the widget

◆ getQtDesignerPluginInfo()

taurus.taurusdartboard.TaurusDartBoard.getQtDesignerPluginInfo ( cls)

Provides Qt Designer with widget information.

Return: dict Dictionary with values for keys: icon, module, container, tool_tip and xml.

Member Data Documentation

◆ bgRole

taurus.taurusdartboard.TaurusDartBoard.bgRole = Qt.Property("QString", getBgRole, setBgRole, resetBgRole, doc="background role")
static

This property holds the background role.

Valid values are None, "quality", "state"

Access functions:

◆ fgRole

taurus.taurusdartboard.TaurusDartBoard.fgRole = Qt.Property("QString", getFgRole, setFgRole, resetFgRole, doc="foreground role")
static

This property holds the foreground role.

Valid values are:

  • None - no value is displayed
  • "value" - the value is displayed
  • "w_value" - the write value is displayed

Access functions:

◆ model

taurus.taurusdartboard.TaurusDartBoard.model = Qt.Property("QString", TaurusBaseWidget.getModel, setModel, TaurusBaseWidget.resetModel)
static

This property holds the unique URI string representing the model name with which this widget will get its data from.

Access functions:

◆ modelIndex

taurus.taurusdartboard.TaurusDartBoard.modelIndex = Qt.Property("QString", getModelIndex, setModelIndex, resetModelIndex)
static

This property holds the index inside the model value that should be displayed.

Access functions:


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