|
18
|
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.IChecker</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> <a
|
|
|
20 href="module-tree.html">Trees</a> </th>
|
|
|
21
|
|
|
22 <!-- Index link -->
|
|
|
23 <th> <a
|
|
|
24 href="identifier-index.html">Indices</a> </th>
|
|
|
25
|
|
|
26 <!-- Help link -->
|
|
|
27 <th> <a
|
|
|
28 href="help.html">Help</a> </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 commons ::
|
|
|
38 <a href="commons.Checker-module.html">Module Checker</a> ::
|
|
|
39 Class IChecker
|
|
|
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 private</a>]</span></td></tr>
|
|
|
47 <tr><td align="right"><span class="options"
|
|
|
48 >[<a href="frames.html" target="_top">frames</a
|
|
|
49 >] | <a href="commons.Checker.IChecker-class.html"
|
|
|
50 target="_top">no frames</a>]</span></td></tr>
|
|
|
51 </table>
|
|
|
52 </td>
|
|
|
53 </tr>
|
|
|
54 </table>
|
|
|
55 <!-- ==================== CLASS DESCRIPTION ==================== -->
|
|
|
56 <h1 class="epydoc">Class IChecker</h1><p class="nomargin-top"><span class="codelink"><a href="commons.Checker-pysrc.html#IChecker">source code</a></span></p>
|
|
|
57 <dl><dt>Known Subclasses:</dt>
|
|
|
58 <dd>
|
|
|
59 <ul class="subclass-list">
|
|
|
60 <li><a href="commons.Checker.Checker-class.html">Checker</a></li><li>, <a href="commons.Checker.ConfigChecker-class.html">ConfigChecker</a></li> </ul>
|
|
|
61 </dd></dl>
|
|
|
62
|
|
|
63 <hr />
|
|
|
64 <p>Interface emulation for a checker</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"> </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 href="commons.Checker.IChecker-class.html#check" class="summary-sig-name">check</a>(<span class="summary-sig-arg">self</span>,
|
|
|
90 <span class="summary-sig-arg">arg</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br />
|
|
|
91 perform check, raise a CheckerException if error occured</td>
|
|
|
92 <td align="right" valign="top">
|
|
|
93 <span class="codelink"><a href="commons.Checker-pysrc.html#IChecker.check">source code</a></span>
|
|
|
94
|
|
|
95 </td>
|
|
|
96 </tr>
|
|
|
97 </table>
|
|
|
98
|
|
|
99 </td>
|
|
|
100 </tr>
|
|
|
101 </table>
|
|
|
102 <!-- ==================== METHOD DETAILS ==================== -->
|
|
|
103 <a name="section-MethodDetails"></a>
|
|
|
104 <table class="details" border="1" cellpadding="3"
|
|
|
105 cellspacing="0" width="100%" bgcolor="white">
|
|
|
106 <tr bgcolor="#70b0f0" class="table-header">
|
|
|
107 <td colspan="2" class="table-header">
|
|
|
108 <table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
|
109 <tr valign="top">
|
|
|
110 <td align="left"><span class="table-header">Method Details</span></td>
|
|
|
111 <td align="right" valign="top"
|
|
|
112 ><span class="options">[<a href="#section-MethodDetails"
|
|
|
113 class="privatelink" onclick="toggle_private();"
|
|
|
114 >hide private</a>]</span></td>
|
|
|
115 </tr>
|
|
|
116 </table>
|
|
|
117 </td>
|
|
|
118 </tr>
|
|
|
119 </table>
|
|
|
120 <a name="check"></a>
|
|
|
121 <div>
|
|
|
122 <table class="details" border="1" cellpadding="3"
|
|
|
123 cellspacing="0" width="100%" bgcolor="white">
|
|
|
124 <tr><td>
|
|
|
125 <table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
|
126 <tr valign="top"><td>
|
|
|
127 <h3 class="epydoc"><span class="sig"><span class="sig-name">check</span>(<span class="sig-arg">self</span>,
|
|
|
128 <span class="sig-arg">arg</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span>
|
|
|
129 </h3>
|
|
|
130 </td><td align="right" valign="top"
|
|
|
131 ><span class="codelink"><a href="commons.Checker-pysrc.html#IChecker.check">source code</a></span>
|
|
|
132 </td>
|
|
|
133 </tr></table>
|
|
|
134
|
|
|
135 <p>perform check, raise a CheckerException if error occured</p>
|
|
|
136 <dl class="fields">
|
|
|
137 <dt>Parameters:</dt>
|
|
|
138 <dd><ul class="nomargin-top">
|
|
|
139 <li><strong class="pname"><code>arg</code></strong> (choose the appropriate type) - a collecting parameter: put here all you need to perform check</li>
|
|
|
140 </ul></dd>
|
|
|
141 </dl>
|
|
|
142 </td></tr></table>
|
|
|
143 </div>
|
|
|
144 <br />
|
|
|
145 <!-- ==================== NAVIGATION BAR ==================== -->
|
|
|
146 <table class="navbar" border="0" width="100%" cellpadding="0"
|
|
|
147 bgcolor="#a0c0ff" cellspacing="0">
|
|
|
148 <tr valign="middle">
|
|
|
149
|
|
|
150 <!-- Tree link -->
|
|
|
151 <th> <a
|
|
|
152 href="module-tree.html">Trees</a> </th>
|
|
|
153
|
|
|
154 <!-- Index link -->
|
|
|
155 <th> <a
|
|
|
156 href="identifier-index.html">Indices</a> </th>
|
|
|
157
|
|
|
158 <!-- Help link -->
|
|
|
159 <th> <a
|
|
|
160 href="help.html">Help</a> </th>
|
|
|
161
|
|
|
162 <th class="navbar" width="100%"></th>
|
|
|
163 </tr>
|
|
|
164 </table>
|
|
|
165 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
|
|
166 <tr>
|
|
|
167 <td align="left" class="footer">
|
|
|
168 Generated by Epydoc 3.0.1 on Fri Apr 10 16:39:01 2009
|
|
|
169 </td>
|
|
|
170 <td align="right" class="footer">
|
|
|
171 <a target="mainFrame" href="http://epydoc.sourceforge.net"
|
|
|
172 >http://epydoc.sourceforge.net</a>
|
|
|
173 </td>
|
|
|
174 </tr>
|
|
|
175 </table>
|
|
|
176
|
|
|
177 <script type="text/javascript">
|
|
|
178 <!--
|
|
|
179 // Private objects are initially displayed (because if
|
|
|
180 // javascript is turned off then we want them to be
|
|
|
181 // visible); but by default, we want to hide them. So hide
|
|
|
182 // them unless we have a cookie that says to show them.
|
|
|
183 checkCookie();
|
|
|
184 // -->
|
|
|
185 </script>
|
|
|
186 </body>
|
|
|
187 </html>
|
