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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
|
<?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.ConfigDataFile</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> ::
<a href="Gnumed.pycommon.gmConfigCommon-module.html">Module gmConfigCommon</a> ::
Class ConfigDataFile
</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.ConfigDataFile-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class ConfigDataFile</h1><p class="nomargin-top"><span class="codelink"><a href="Gnumed.pycommon.gmConfigCommon-pysrc.html#ConfigDataFile">source code</a></span></p>
<pre class="base-tree">
<a href="Gnumed.pycommon.gmConfigCommon.ConfigData-class.html">ConfigData</a> --+
|
<strong class="uidshort">ConfigDataFile</strong>
</pre>
<hr />
<p>Class that holds config data for a particular config file</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="Gnumed.pycommon.gmConfigCommon.ConfigDataFile-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">aFilename</span>=<span class="summary-sig-default">None</span>)</span><br />
Init config file</td>
<td align="right" valign="top">
<span class="codelink"><a href="Gnumed.pycommon.gmConfigCommon-pysrc.html#ConfigDataFile.__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="GetFullPath"></a><span class="summary-sig-name">GetFullPath</span>(<span class="summary-sig-arg">self</span>)</span><br />
returns the absolute path to the config file in use</td>
<td align="right" valign="top">
<span class="codelink"><a href="Gnumed.pycommon.gmConfigCommon-pysrc.html#ConfigDataFile.GetFullPath">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 href="Gnumed.pycommon.gmConfigCommon.ConfigDataFile-class.html#GetConfigData" class="summary-sig-name">GetConfigData</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">aParameterName</span>=<span class="summary-sig-default">None</span>)</span><br />
Gets Config Data for a particular parameter.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Gnumed.pycommon.gmConfigCommon-pysrc.html#ConfigDataFile.GetConfigData">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 href="Gnumed.pycommon.gmConfigCommon.ConfigDataFile-class.html#SetConfigData" class="summary-sig-name">SetConfigData</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">aParameterName</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">aValue</span>=<span class="summary-sig-default">None</span>)</span><br />
Sets Config Data for a particular parameter.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Gnumed.pycommon.gmConfigCommon-pysrc.html#ConfigDataFile.SetConfigData">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 href="Gnumed.pycommon.gmConfigCommon.ConfigDataFile-class.html#AddConfigParam" class="summary-sig-name">AddConfigParam</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">aParameterName</span>,
<span class="summary-sig-arg">aType</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">aValue</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">aDescription</span>=<span class="summary-sig-default">None</span>)</span><br />
Adds a new config parameter.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Gnumed.pycommon.gmConfigCommon-pysrc.html#ConfigDataFile.AddConfigParam">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 href="Gnumed.pycommon.gmConfigCommon.ConfigDataFile-class.html#getAllNames" class="summary-sig-name">getAllNames</a>(<span class="summary-sig-arg">self</span>)</span><br />
fetch names and parameter data from config file.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Gnumed.pycommon.gmConfigCommon-pysrc.html#ConfigDataFile.getAllNames">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 href="Gnumed.pycommon.gmConfigCommon.ConfigDataFile-class.html#getRawName" class="summary-sig-name">getRawName</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">aParameterName</span>=<span class="summary-sig-default">None</span>)</span><br />
Returns the parameter name without possible cookie part(s).</td>
<td align="right" valign="top">
<span class="codelink"><a href="Gnumed.pycommon.gmConfigCommon-pysrc.html#ConfigDataFile.getRawName">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="Gnumed.pycommon.gmConfigCommon.ConfigData-class.html">ConfigData</a></code></b>:
<code><a href="Gnumed.pycommon.gmConfigCommon.ConfigData-class.html#GetAllNames">GetAllNames</a></code>,
<code><a href="Gnumed.pycommon.gmConfigCommon.ConfigData-class.html#getParamDescription">getParamDescription</a></code>,
<code><a href="Gnumed.pycommon.gmConfigCommon.ConfigData-class.html#getParamType">getParamType</a></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">aFilename</span>=<span class="sig-default">None</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Gnumed.pycommon.gmConfigCommon-pysrc.html#ConfigDataFile.__init__">source code</a></span>
</td>
</tr></table>
<p>Init config file</p>
<dl class="fields">
<dt>Overrides:
<a href="Gnumed.pycommon.gmConfigCommon.ConfigData-class.html#__init__">ConfigData.__init__</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="GetConfigData"></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">GetConfigData</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">aParameterName</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Gnumed.pycommon.gmConfigCommon-pysrc.html#ConfigDataFile.GetConfigData">source code</a></span>
</td>
</tr></table>
<p>Gets Config Data for a particular parameter. Returns parameter
value.</p>
<dl class="fields">
<dt>Overrides:
<a href="Gnumed.pycommon.gmConfigCommon.ConfigData-class.html#GetConfigData">ConfigData.GetConfigData</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="SetConfigData"></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">SetConfigData</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">aParameterName</span>=<span class="sig-default">None</span>,
<span class="sig-arg">aValue</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Gnumed.pycommon.gmConfigCommon-pysrc.html#ConfigDataFile.SetConfigData">source code</a></span>
</td>
</tr></table>
<p>Sets Config Data for a particular parameter.</p>
<dl class="fields">
<dt>Overrides:
<a href="Gnumed.pycommon.gmConfigCommon.ConfigData-class.html#SetConfigData">ConfigData.SetConfigData</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="AddConfigParam"></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">AddConfigParam</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">aParameterName</span>,
<span class="sig-arg">aType</span>=<span class="sig-default">None</span>,
<span class="sig-arg">aValue</span>=<span class="sig-default">None</span>,
<span class="sig-arg">aDescription</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Gnumed.pycommon.gmConfigCommon-pysrc.html#ConfigDataFile.AddConfigParam">source code</a></span>
</td>
</tr></table>
<p>Adds a new config parameter.</p>
<dl class="fields">
<dt>Overrides:
<a href="Gnumed.pycommon.gmConfigCommon.ConfigData-class.html#AddConfigParam">ConfigData.AddConfigParam</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="getAllNames"></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">getAllNames</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Gnumed.pycommon.gmConfigCommon-pysrc.html#ConfigDataFile.getAllNames">source code</a></span>
</td>
</tr></table>
<p>fetch names and parameter data from config file. Returns list of
parameter names where group and option name are concatenated.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="getRawName"></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">getRawName</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">aParameterName</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Gnumed.pycommon.gmConfigCommon-pysrc.html#ConfigDataFile.getRawName">source code</a></span>
</td>
</tr></table>
<p>Returns the parameter name without possible cookie part(s). Needed to
indentify matching config definition entry.</p>
<dl class="fields">
<dt>Overrides:
<a href="Gnumed.pycommon.gmConfigCommon.ConfigData-class.html#getRawName">ConfigData.getRawName</a>
</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="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:10 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>
|
