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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
|
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Camelot.camelot.view.model_thread.AbstractModelThread</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="Camelot.camelot-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.python-camelot.com">Camelot</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package Camelot ::
<a href="Camelot.camelot-module.html">Package camelot</a> ::
<a href="Camelot.camelot.view-module.html">Package view</a> ::
<a href="Camelot.camelot.view.model_thread-module.html">Package model_thread</a> ::
Class AbstractModelThread
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="Camelot.camelot.view.model_thread.AbstractModelThread-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class AbstractModelThread</h1><p class="nomargin-top"><span class="codelink"><a href="Camelot.camelot.view.model_thread-pysrc.html#AbstractModelThread">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_camelot__239" name="uml_class_diagram_for_camelot__239">
<area shape="rect" href="Camelot.camelot.view.model_thread.AbstractModelThread-class.html#thread_busy_signal" title="Camelot.camelot.view.model_thread.AbstractModelThread.thread_busy_signal" alt="" coords="17,28,409,47"/>
<area shape="rect" href="Camelot.camelot.view.model_thread.AbstractModelThread-class.html#__init__" title="@param setup_thread: function to be called at startup of the thread to initialize everything, by default this will setup the model.  set to None if nothing should be done." alt="" coords="17,49,409,68"/>
<area shape="rect" href="Camelot.camelot.view.model_thread.AbstractModelThread-class.html#run" title="Camelot.camelot.view.model_thread.AbstractModelThread.run" alt="" coords="17,68,409,87"/>
<area shape="rect" href="Camelot.camelot.view.model_thread.AbstractModelThread-class.html#traceback" title="The formatted traceback of the last exception in the model thread" alt="" coords="17,87,409,105"/>
<area shape="rect" href="Camelot.camelot.view.model_thread.AbstractModelThread-class.html#wait_on_work" title="Wait for all work to be finished, this function should only be used to do unit testing and such, since it will block the calling thread until all work is done" alt="" coords="17,105,409,124"/>
<area shape="rect" href="Camelot.camelot.view.model_thread.AbstractModelThread-class.html#post" title="Post a request to the model thread, request should be a function that takes no arguments.  The request function will be called within the model thread.  When the request is finished, on first occasion, the response function will be called within the gui thread.  The response function takes as arguments, the results of the request function. @param request: function to be called within the model thread @param response: a slot that will be called with the result of the request function @param exception: a slot that will be called in case request throws an exception" alt="" coords="17,124,409,143"/>
<area shape="rect" href="Camelot.camelot.view.model_thread.AbstractModelThread-class.html#busy" title="Return True or False indicating wether either the model or the gui thread is doing something" alt="" coords="17,143,409,161"/>
<area shape="rect" href="Camelot.camelot.view.model_thread.AbstractModelThread-class.html" title="Abstract implementation of a model thread class Thread in which the model runs, all requests to the model should be posted to the the model thread." alt="" coords="16,11,411,163"/>
</map>
<img src="uml_class_diagram_for_camelot__239.gif" alt='' usemap="#uml_class_diagram_for_camelot__239" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>Abstract implementation of a model thread class
Thread in which the model runs, all requests to the model should be
posted to the the model thread.</p>
<p>This class ensures the gui thread doesn't block when the model needs
time to complete tasks by providing asynchronous communication between
the model thread and the gui thread</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Instance Methods</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Camelot.camelot.view.model_thread.AbstractModelThread-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">setup_thread</span>=<span class="summary-sig-default"><function setup_model at 0xc217b54></span>)</span><br />
@param setup_thread: function to be called at startup of the thread to initialize
everything, by default this will setup the model. set to None if nothing should
be done.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.model_thread-pysrc.html#AbstractModelThread.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="run"></a><span class="summary-sig-name">run</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.model_thread-pysrc.html#AbstractModelThread.run">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="traceback"></a><span class="summary-sig-name">traceback</span>(<span class="summary-sig-arg">self</span>)</span><br />
The formatted traceback of the last exception in the model thread</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.model_thread-pysrc.html#AbstractModelThread.traceback">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="wait_on_work"></a><span class="summary-sig-name">wait_on_work</span>(<span class="summary-sig-arg">self</span>)</span><br />
Wait for all work to be finished, this function should only be used
to do unit testing and such, since it will block the calling thread until
all work is done</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.model_thread-pysrc.html#AbstractModelThread.wait_on_work">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="post"></a><span class="summary-sig-name">post</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">request</span>,
<span class="summary-sig-arg">response</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">exception</span>=<span class="summary-sig-default">None</span>)</span><br />
Post a request to the model thread, request should be
a function that takes no arguments. The request function
will be called within the model thread. When the request
is finished, on first occasion, the response function will be
called within the gui thread. The response function takes as
arguments, the results of the request function.
@param request: function to be called within the model thread
@param response: a slot that will be called with the result of the
request function
@param exception: a slot that will be called in case request throws
an exception</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.model_thread-pysrc.html#AbstractModelThread.post">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="busy"></a><span class="summary-sig-name">busy</span>(<span class="summary-sig-arg">self</span>)</span><br />
Return True or False indicating wether either the model or the
gui thread is doing something</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.model_thread-pysrc.html#AbstractModelThread.busy">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Class Variables</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="thread_busy_signal"></a><span class="summary-name">thread_busy_signal</span> = <code title="'2thread_busy'"><code class="variable-quote">'</code><code class="variable-string">2thread_busy</code><code class="variable-quote">'</code></code>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Properties</span></td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">setup_thread</span>=<span class="sig-default"><function setup_model at 0xc217b54></span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Camelot.camelot.view.model_thread-pysrc.html#AbstractModelThread.__init__">source code</a></span>
</td>
</tr></table>
@param setup_thread: function to be called at startup of the thread to initialize
everything, by default this will setup the model. set to None if nothing should
be done.
<dl class="fields">
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="Camelot.camelot-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.python-camelot.com">Camelot</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Sat Jun 12 15:41:55 2010
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|
