1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
#!/usr/bin/env python
#############################################################################
##
# This file is part of Taurus
##
# http://taurus-scada.org
##
# Copyright 2011 CELLS / ALBA Synchrotron, Bellaterra, Spain
##
# Taurus is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
##
# Taurus is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
##
# You should have received a copy of the GNU Lesser General Public License
# along with Taurus. If not, see <http://www.gnu.org/licenses/>.
##
#############################################################################
__all__ = ["ForcedReadTool"]
from taurus.external.qt import QtGui, QtCore
from taurus.qt.qtcore.configuration import BaseConfigurableClass
class ForcedReadTool(QtGui.QAction, BaseConfigurableClass):
"""
This tool provides a menu option to control the "Forced Read" period of
Plot data items that implement a `setForcedReadPeriod` method
(see, e.g. :meth:`TaurusTrendSet.setForcedReadPeriod`).
The force-read feature consists on forcing periodic attribute reads for
those attributes being plotted with a :class:`TaurusTrendSet` object.
This allows to force plotting periodical updates even for attributes
for which the taurus polling is not enabled.
Note that this is done at the widget level and therefore does not affect
the rate of arrival of events for other widgets connected to the same
attributes
This tool inserts an action with a spinbox and emits a `valueChanged`
signal whenever the value is changed.
The connection between the data items and this tool can be done manually
(by connecting to the `valueChanged` signal or automatically, if
:meth:`autoconnect()` is `True` (default). The autoconnection feature works
by discovering the compliant data items that share associated to the
plot_item.
This tool is implemented as an Action, and provides a method to attach it
to a :class:`pyqtgraph.PlotItem`
"""
valueChanged = QtCore.pyqtSignal(int)
def __init__(
self,
parent=None,
period=0,
text="Change forced read period...",
autoconnect=True,
):
BaseConfigurableClass.__init__(self)
QtGui.QAction.__init__(self, text, parent)
tt = "Period between forced readings.\nSet to 0 to disable"
self.setToolTip(tt)
self._period = period
self._autoconnect = autoconnect
# register config properties
self.registerConfigProperty(self.period, self.setPeriod, "period")
self.registerConfigProperty(
self.autoconnect, self.setAutoconnect, "autoconnect"
)
# internal conections
self.triggered.connect(self._onTriggered)
def _onTriggered(self):
period = self.period()
period, ok = QtGui.QInputDialog.getInt(
self.parentWidget(),
"New read period",
"Period (in ms) between forced readings.\nSet to 0 to disable",
period,
0,
604800000,
500,
)
if ok:
self.setPeriod(period)
def attachToPlotItem(self, plot_item):
"""Use this method to add this tool to a plot
:param plot_item: (PlotItem)
"""
menu = plot_item.getViewBox().menu
menu.addAction(self)
self.plot_item = plot_item
# force an update of period for connected trendsets
self.setPeriod(self.period())
if self.autoconnect():
# enable the forced reading also for trendsets added in the future
try: # requires https://github.com/pyqtgraph/pyqtgraph/pull/1388
plot_item.scene().sigItemAdded.connect(self._onAddedItem)
except AttributeError:
pass
def _onAddedItem(self, item):
if hasattr(item, "setForcedReadPeriod"):
item.setForcedReadPeriod(self.period())
def autoconnect(self):
"""Returns autoconnect state
:return: (bool)
"""
return self._autoconnect
def setAutoconnect(self, autoconnect):
"""Set autoconnect state. If True, the tool will autodetect trendsets
associated to the plot item and will call setForcedReadPeriod
on each of them for each change. If False, it will only emit a
valueChanged signal and only those connected to it will be notified
of changes
:param autoconnect: (bool)
"""
self._autoconnect = autoconnect
def period(self):
"""Returns the current period value (in ms)
:return: (int)
"""
return self._period
def setPeriod(self, period):
"""Change the period value. Use 0 for disabling
:param period: (int) period in ms
"""
self._period = period
# update existing items
if self.autoconnect() and self.plot_item is not None:
for item in self.plot_item.listDataItems():
if hasattr(item, "setForcedReadPeriod"):
item.setForcedReadPeriod(period)
# emit valueChanged
self.valueChanged.emit(period)
if __name__ == "__main__":
import taurus
taurus.setLogLevel(taurus.Debug)
import sys
from taurus.qt.qtgui.application import TaurusApplication
from taurus_pyqtgraph import TaurusTrendSet, DateAxisItem
import pyqtgraph as pg
# from taurus_pyqtgraph import ForcedReadTool
app = TaurusApplication()
w = pg.PlotWidget()
axis = DateAxisItem(orientation="bottom")
w = pg.PlotWidget()
axis.attachToPlotItem(w.getPlotItem())
# test adding the curve before the tool
ts1 = TaurusTrendSet(name="before", symbol="o")
ts1.setModel("eval:rand()+1")
w.addItem(ts1)
fr = ForcedReadTool(w, period=1000)
fr.attachToPlotItem(w.getPlotItem())
# test adding the curve after the tool
ts2 = TaurusTrendSet(name="after", symbol="+")
ts2.setModel("eval:rand()")
w.addItem(ts2)
w.show()
ret = app.exec_()
import pprint
pprint.pprint(fr.createConfig())
sys.exit(ret)
|
