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
|
<?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>Gnumed.pycommon.gmConfigCommon</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="Gnumed-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.gnumed.org">GNUmed Never Sleeps</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="Gnumed-module.html">Package Gnumed</a> ::
<a href="Gnumed.pycommon-module.html">Package pycommon</a> ::
Module gmConfigCommon
</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="Gnumed.pycommon.gmConfigCommon-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module gmConfigCommon</h1><p class="nomargin-top"><span class="codelink"><a href="Gnumed.pycommon.gmConfigCommon-pysrc.html">source code</a></span></p>
<p>GNUmed: Mid-level configuration editor object.</p>
<p>Theory of operation:</p>
<p>ConfigSourceDB/File holds config data (read from backend or file) and
related config definitions. Definitions are retrieved automatically from
a given config definition file (if available). See _defaultDefSourceTable
below for standard file names.</p>
<p>First get a list of available config parameters through
getAllParamNames (returns names + metadata), get the values using
GetConfigData, change, check for validity using isValid (if definition
data and parameter definition is available) and set data using
SetConfigData. License: GNU Public License</p>
<hr />
<div class="fields"> <p><strong>Version:</strong>
$Revision: 1.10 $
</p>
<p><strong>Author:</strong>
H.Berger,K.Hilbert
</p>
</div><!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></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">Classes</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="Gnumed.pycommon.gmConfigCommon.ConfigSource-class.html" class="summary-name">ConfigSource</a><br />
Base class for interface to access config data and definitions on a
single configuration source (config file, user/workplace specific
backend data collection.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="Gnumed.pycommon.gmConfigCommon.ConfigSourceDB-class.html" class="summary-name">ConfigSourceDB</a><br />
Interface to access config data and definitions in a single
configuration user/workplace specific backend data collection.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="Gnumed.pycommon.gmConfigCommon.ConfigSourceFile-class.html" class="summary-name">ConfigSourceFile</a><br />
Interface to access config data and definitions in a config file.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="Gnumed.pycommon.gmConfigCommon.ParameterDefinition-class.html" class="summary-name">ParameterDefinition</a><br />
Describes a gnumed configuration parameter.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="Gnumed.pycommon.gmConfigCommon.ConfigDefinition-class.html" class="summary-name">ConfigDefinition</a><br />
holds config definitions read from a file/DB.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="Gnumed.pycommon.gmConfigCommon.ConfigData-class.html" class="summary-name">ConfigData</a><br />
Base class.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="Gnumed.pycommon.gmConfigCommon.ConfigDataDB-class.html" class="summary-name">ConfigDataDB</a><br />
Class that holds config data for a particular user/workplace pair
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="Gnumed.pycommon.gmConfigCommon.ConfigDataFile-class.html" class="summary-name">ConfigDataFile</a><br />
Class that holds config data for a particular config file
</td>
</tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></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">Functions</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="Gnumed.pycommon.gmConfigCommon-module.html#exportDBSet" class="summary-sig-name">exportDBSet</a>(<span class="summary-sig-arg">filename</span>,
<span class="summary-sig-arg">aUser</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">aWorkplace</span>=<span class="summary-sig-default">'xxxDEFAULTxxx'</span>)</span><br />
Fetches a backend stored set of config options (defined by user and
workplace) and returns it as a plain text file.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Gnumed.pycommon.gmConfigCommon-pysrc.html#exportDBSet">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="importDBSet"></a><span class="summary-sig-name">importDBSet</span>(<span class="summary-sig-arg">filename</span>,
<span class="summary-sig-arg">aUser</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">aWorkplace</span>=<span class="summary-sig-default">'xxxDEFAULTxxx'</span>)</span><br />
get config definitions from a file exported with exportDBSet().</td>
<td align="right" valign="top">
<span class="codelink"><a href="Gnumed.pycommon.gmConfigCommon-pysrc.html#importDBSet">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<p class="indent-wrapped-lines"><b>Imports:</b>
<span title="sys">sys</span>,
<span title="os">os</span>,
<span title="string">string</span>,
<span title="types">types</span>,
<span title="pickle">pickle</span>,
<a href="Gnumed.pycommon.gmCfg-module.html" title="Gnumed.pycommon.gmCfg">gmCfg</a>,
<a href="Gnumed.pycommon.gmPG2-module.html" title="Gnumed.pycommon.gmPG2">gmPG2</a>
</p><br />
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></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">Function Details</span></td>
</tr>
</table>
<a name="exportDBSet"></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">exportDBSet</span>(<span class="sig-arg">filename</span>,
<span class="sig-arg">aUser</span>=<span class="sig-default">None</span>,
<span class="sig-arg">aWorkplace</span>=<span class="sig-default">'xxxDEFAULTxxx'</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Gnumed.pycommon.gmConfigCommon-pysrc.html#exportDBSet">source code</a></span>
</td>
</tr></table>
<p>Fetches a backend stored set of config options (defined by user and
workplace) and returns it as a plain text file. NOTE: This will not write
"valid value" information, since this is only hold in config
definition files ! Returns: 1 for success, 0 if no parameters were found,
None on failure.</p>
<dl class="fields">
</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="Gnumed-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.gnumed.org">GNUmed Never Sleeps</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 Mon Jun 25 03:58:07 2012
</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>
|
