Mercurial > repos > yufei-luo > s_mart

comparison commons/pyRepetUnit/doc/commons.Checker.ConfigChecker-class.html @ 31:0ab839023fe4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author m-zytnicki
date Tue, 30 Apr 2013 14:33:21 -0400
parents 94ab73e8a190
children
comparison
equal deleted inserted replaced
30:5677346472b5 31:0ab839023fe4
1 <?xml version="1.0" encoding="ascii"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5 <head>
6 <title>commons.Checker.ConfigChecker</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9 </head>
10
11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13 <!-- ==================== NAVIGATION BAR ==================== -->
14 <table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17
18 <!-- Tree link -->
19 <th>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21
22 <!-- Index link -->
23 <th>&nbsp;&nbsp;&nbsp;<a
24 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25
26 <!-- Help link -->
27 <th>&nbsp;&nbsp;&nbsp;<a
28 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
29
30 <th class="navbar" width="100%"></th>
31 </tr>
32 </table>
33 <table width="100%" cellpadding="0" cellspacing="0">
34 <tr valign="top">
35 <td width="100%">
36 <span class="breadcrumbs">
37 Package&nbsp;commons ::
38 <a href="commons.Checker-module.html">Module&nbsp;Checker</a> ::
39 Class&nbsp;ConfigChecker
40 </span>
41 </td>
42 <td>
43 <table cellpadding="0" cellspacing="0">
44 <!-- hide/show private -->
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
46 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
47 <tr><td align="right"><span class="options"
48 >[<a href="frames.html" target="_top">frames</a
49 >]&nbsp;|&nbsp;<a href="commons.Checker.ConfigChecker-class.html"
50 target="_top">no&nbsp;frames</a>]</span></td></tr>
51 </table>
52 </td>
53 </tr>
54 </table>
55 <!-- ==================== CLASS DESCRIPTION ==================== -->
56 <h1 class="epydoc">Class ConfigChecker</h1><p class="nomargin-top"><span class="codelink"><a href="commons.Checker-pysrc.html#ConfigChecker">source&nbsp;code</a></span></p>
57 <pre class="base-tree">
58 <a href="commons.Checker.IChecker-class.html">IChecker</a> --+
59 |
60 <strong class="uidshort">ConfigChecker</strong>
61 </pre>
62
63 <hr />
64 <p>A checker for config file.</p>
65
66 <!-- ==================== INSTANCE METHODS ==================== -->
67 <a name="section-InstanceMethods"></a>
68 <table class="summary" border="1" cellpadding="3"
69 cellspacing="0" width="100%" bgcolor="white">
70 <tr bgcolor="#70b0f0" class="table-header">
71 <td colspan="2" class="table-header">
72 <table border="0" cellpadding="0" cellspacing="0" width="100%">
73 <tr valign="top">
74 <td align="left"><span class="table-header">Instance Methods</span></td>
75 <td align="right" valign="top"
76 ><span class="options">[<a href="#section-InstanceMethods"
77 class="privatelink" onclick="toggle_private();"
78 >hide private</a>]</span></td>
79 </tr>
80 </table>
81 </td>
82 </tr>
83 <tr>
84 <td width="15%" align="right" valign="top" class="summary">
85 <span class="summary-type">&nbsp;</span>
86 </td><td class="summary">
87 <table width="100%" cellpadding="0" cellspacing="0" border="0">
88 <tr>
89 <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
90 <span class="summary-sig-arg">sectionName</span>,
91 <span class="summary-sig-arg">optionsDict</span>)</span></td>
92 <td align="right" valign="top">
93 <span class="codelink"><a href="commons.Checker-pysrc.html#ConfigChecker.__init__">source&nbsp;code</a></span>
94
95 </td>
96 </tr>
97 </table>
98
99 </td>
100 </tr>
101 <tr>
102 <td width="15%" align="right" valign="top" class="summary">
103 <span class="summary-type">&nbsp;</span>
104 </td><td class="summary">
105 <table width="100%" cellpadding="0" cellspacing="0" border="0">
106 <tr>
107 <td><span class="summary-sig"><a href="commons.Checker.ConfigChecker-class.html#check" class="summary-sig-name">check</a>(<span class="summary-sig-arg">self</span>,
108 <span class="summary-sig-arg">configFile</span>)</span><br />
109 perform check, raise a CheckerException if error occured</td>
110 <td align="right" valign="top">
111 <span class="codelink"><a href="commons.Checker-pysrc.html#ConfigChecker.check">source&nbsp;code</a></span>
112
113 </td>
114 </tr>
115 </table>
116
117 </td>
118 </tr>
119 </table>
120 <!-- ==================== INSTANCE VARIABLES ==================== -->
121 <a name="section-InstanceVariables"></a>
122 <table class="summary" border="1" cellpadding="3"
123 cellspacing="0" width="100%" bgcolor="white">
124 <tr bgcolor="#70b0f0" class="table-header">
125 <td colspan="2" class="table-header">
126 <table border="0" cellpadding="0" cellspacing="0" width="100%">
127 <tr valign="top">
128 <td align="left"><span class="table-header">Instance Variables</span></td>
129 <td align="right" valign="top"
130 ><span class="options">[<a href="#section-InstanceVariables"
131 class="privatelink" onclick="toggle_private();"
132 >hide private</a>]</span></td>
133 </tr>
134 </table>
135 </td>
136 </tr>
137 <tr>
138 <td width="15%" align="right" valign="top" class="summary">
139 <span class="summary-type">class Dict</span>
140 </td><td class="summary">
141 <a name="optionsDict"></a><span class="summary-name">optionsDict</span><br />
142 dict with option to check as keys and empty strings &quot;&quot; as
143 values
144 </td>
145 </tr>
146 <tr>
147 <td width="15%" align="right" valign="top" class="summary">
148 <span class="summary-type">str</span>
149 </td><td class="summary">
150 <a name="sectionName"></a><span class="summary-name">sectionName</span><br />
151 section to check in config file
152 </td>
153 </tr>
154 </table>
155 <!-- ==================== METHOD DETAILS ==================== -->
156 <a name="section-MethodDetails"></a>
157 <table class="details" border="1" cellpadding="3"
158 cellspacing="0" width="100%" bgcolor="white">
159 <tr bgcolor="#70b0f0" class="table-header">
160 <td colspan="2" class="table-header">
161 <table border="0" cellpadding="0" cellspacing="0" width="100%">
162 <tr valign="top">
163 <td align="left"><span class="table-header">Method Details</span></td>
164 <td align="right" valign="top"
165 ><span class="options">[<a href="#section-MethodDetails"
166 class="privatelink" onclick="toggle_private();"
167 >hide private</a>]</span></td>
168 </tr>
169 </table>
170 </td>
171 </tr>
172 </table>
173 <a name="check"></a>
174 <div>
175 <table class="details" border="1" cellpadding="3"
176 cellspacing="0" width="100%" bgcolor="white">
177 <tr><td>
178 <table width="100%" cellpadding="0" cellspacing="0" border="0">
179 <tr valign="top"><td>
180 <h3 class="epydoc"><span class="sig"><span class="sig-name">check</span>(<span class="sig-arg">self</span>,
181 <span class="sig-arg">configFile</span>)</span>
182 </h3>
183 </td><td align="right" valign="top"
184 ><span class="codelink"><a href="commons.Checker-pysrc.html#ConfigChecker.check">source&nbsp;code</a></span>&nbsp;
185 </td>
186 </tr></table>
187
188 <p>perform check, raise a CheckerException if error occured</p>
189 <dl class="fields">
190 <dt>Parameters:</dt>
191 <dd><ul class="nomargin-top">
192 <li><strong class="pname"><code>arg</code></strong> - a collecting parameter: put here all you need to perform check</li>
193 </ul></dd>
194 <dt>Overrides:
195 <a href="commons.Checker.IChecker-class.html#check">IChecker.check</a>
196 <dd><em class="note">(inherited documentation)</em></dd>
197 </dt>
198 </dl>
199 </td></tr></table>
200 </div>
201 <br />
202 <!-- ==================== NAVIGATION BAR ==================== -->
203 <table class="navbar" border="0" width="100%" cellpadding="0"
204 bgcolor="#a0c0ff" cellspacing="0">
205 <tr valign="middle">
206
207 <!-- Tree link -->
208 <th>&nbsp;&nbsp;&nbsp;<a
209 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
210
211 <!-- Index link -->
212 <th>&nbsp;&nbsp;&nbsp;<a
213 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
214
215 <!-- Help link -->
216 <th>&nbsp;&nbsp;&nbsp;<a
217 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
218
219 <th class="navbar" width="100%"></th>
220 </tr>
221 </table>
222 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
223 <tr>
224 <td align="left" class="footer">
225 Generated by Epydoc 3.0.1 on Fri Apr 10 16:39:01 2009
226 </td>
227 <td align="right" class="footer">
228 <a target="mainFrame" href="http://epydoc.sourceforge.net"
229 >http://epydoc.sourceforge.net</a>
230 </td>
231 </tr>
232 </table>
233
234 <script type="text/javascript">
235 <!--
236 // Private objects are initially displayed (because if
237 // javascript is turned off then we want them to be
238 // visible); but by default, we want to hide them. So hide
239 // them unless we have a cookie that says to show them.
240 checkCookie();
241 // -->
242 </script>
243 </body>
244 </html>