|
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>sysdef.api</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 <a href="sysdef-module.html">Package sysdef</a> :: |
|
38 Module api |
|
39 </span> |
|
40 </td> |
|
41 <td> |
|
42 <table cellpadding="0" cellspacing="0"> |
|
43 <!-- hide/show private --> |
|
44 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
|
45 onclick="toggle_private();">hide private</a>]</span></td></tr> |
|
46 <tr><td align="right"><span class="options" |
|
47 >[<a href="frames.html" target="_top">frames</a |
|
48 >] | <a href="sysdef.api-module.html" |
|
49 target="_top">no frames</a>]</span></td></tr> |
|
50 </table> |
|
51 </td> |
|
52 </tr> |
|
53 </table> |
|
54 <!-- ==================== MODULE DESCRIPTION ==================== --> |
|
55 <h1 class="epydoc">Module api</h1><span class="codelink"><a href="sysdef.api-pysrc.html">source code</a></span><br /><br /> |
|
56 <p>System Definition file parser.</p> |
|
57 <p>Priority are not handled yet. |
|
58 Nested task unitlist are not handled properly yet.</p> |
|
59 <p>How to use it:</p> |
|
60 <pre class="rst-literal-block"> |
|
61 sdf = SystemDefinition(filename) |
|
62 for name in sdf.layers: |
|
63 print " + Units in layer %s" % name |
|
64 for unit in sdf.layers[name].units: |
|
65 print " - " + sdf.units[name].id |
|
66 |
|
67 for name in sdf.units: |
|
68 print sdf.units[name].id |
|
69 </pre><br /><br /> |
|
70 |
|
71 <!-- ==================== CLASSES ==================== --> |
|
72 <a name="section-Classes"></a> |
|
73 <table class="summary" border="1" cellpadding="3" |
|
74 cellspacing="0" width="100%" bgcolor="white"> |
|
75 <tr bgcolor="#70b0f0" class="table-header"> |
|
76 <td colspan="2" class="table-header"> |
|
77 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
78 <tr valign="top"> |
|
79 <td align="left"><span class="table-header">Classes</span></td> |
|
80 <td align="right" valign="top" |
|
81 ><span class="options">[<a href="#section-Classes" |
|
82 class="privatelink" onclick="toggle_private();" |
|
83 >hide private</a>]</span></td> |
|
84 </tr> |
|
85 </table> |
|
86 </td> |
|
87 </tr> |
|
88 <tr> |
|
89 <td width="15%" align="right" valign="top" class="summary"> |
|
90 <span class="summary-type"> </span> |
|
91 </td><td class="summary"> |
|
92 <a href="sysdef.api.SysDefElement-class.html" class="summary-name">SysDefElement</a><br /> |
|
93 A generic element of a System Definition. |
|
94 </td> |
|
95 </tr> |
|
96 <tr> |
|
97 <td width="15%" align="right" valign="top" class="summary"> |
|
98 <span class="summary-type"> </span> |
|
99 </td><td class="summary"> |
|
100 <a href="sysdef.api.Unit-class.html" class="summary-name">Unit</a><br /> |
|
101 Abstract unit from SDF file. |
|
102 </td> |
|
103 </tr> |
|
104 <tr class="private"> |
|
105 <td width="15%" align="right" valign="top" class="summary"> |
|
106 <span class="summary-type"> </span> |
|
107 </td><td class="summary"> |
|
108 <a href="sysdef.api._UnitGroup-class.html" class="summary-name">_UnitGroup</a><br /> |
|
109 A group of units. |
|
110 </td> |
|
111 </tr> |
|
112 <tr> |
|
113 <td width="15%" align="right" valign="top" class="summary"> |
|
114 <span class="summary-type"> </span> |
|
115 </td><td class="summary"> |
|
116 <a href="sysdef.api.Layer-class.html" class="summary-name">Layer</a><br /> |
|
117 Abstract layer from SDF file. |
|
118 </td> |
|
119 </tr> |
|
120 <tr> |
|
121 <td width="15%" align="right" valign="top" class="summary"> |
|
122 <span class="summary-type"> </span> |
|
123 </td><td class="summary"> |
|
124 <a href="sysdef.api.Module-class.html" class="summary-name">Module</a><br /> |
|
125 Abstract module from SDF file. |
|
126 </td> |
|
127 </tr> |
|
128 <tr> |
|
129 <td width="15%" align="right" valign="top" class="summary"> |
|
130 <span class="summary-type"> </span> |
|
131 </td><td class="summary"> |
|
132 <a href="sysdef.api.UnitList-class.html" class="summary-name">UnitList</a><br /> |
|
133 Abstract unitlist from SDF file. |
|
134 </td> |
|
135 </tr> |
|
136 <tr> |
|
137 <td width="15%" align="right" valign="top" class="summary"> |
|
138 <span class="summary-type"> </span> |
|
139 </td><td class="summary"> |
|
140 <a href="sysdef.api.BuildLayer-class.html" class="summary-name">BuildLayer</a><br /> |
|
141 Abstract buildlayer. |
|
142 </td> |
|
143 </tr> |
|
144 <tr> |
|
145 <td width="15%" align="right" valign="top" class="summary"> |
|
146 <span class="summary-type"> </span> |
|
147 </td><td class="summary"> |
|
148 <a href="sysdef.api.Option-class.html" class="summary-name">Option</a><br /> |
|
149 Represents an option used in abld calls. |
|
150 </td> |
|
151 </tr> |
|
152 <tr> |
|
153 <td width="15%" align="right" valign="top" class="summary"> |
|
154 <span class="summary-type"> </span> |
|
155 </td><td class="summary"> |
|
156 <a href="sysdef.api.SpecialInstruction-class.html" class="summary-name">SpecialInstruction</a><br /> |
|
157 Reads special instruction command. |
|
158 </td> |
|
159 </tr> |
|
160 <tr> |
|
161 <td width="15%" align="right" valign="top" class="summary"> |
|
162 <span class="summary-type"> </span> |
|
163 </td><td class="summary"> |
|
164 <a href="sysdef.api.Task-class.html" class="summary-name">Task</a><br /> |
|
165 Abstract task node from SDF xml. |
|
166 </td> |
|
167 </tr> |
|
168 <tr> |
|
169 <td width="15%" align="right" valign="top" class="summary"> |
|
170 <span class="summary-type"> </span> |
|
171 </td><td class="summary"> |
|
172 <a href="sysdef.api.Configuration-class.html" class="summary-name">Configuration</a><br /> |
|
173 Abstract configuration from SDF file. |
|
174 </td> |
|
175 </tr> |
|
176 <tr> |
|
177 <td width="15%" align="right" valign="top" class="summary"> |
|
178 <span class="summary-type"> </span> |
|
179 </td><td class="summary"> |
|
180 <a href="sysdef.api.Target-class.html" class="summary-name">Target</a><br /> |
|
181 Abstract target from SDF file. |
|
182 </td> |
|
183 </tr> |
|
184 <tr> |
|
185 <td width="15%" align="right" valign="top" class="summary"> |
|
186 <span class="summary-type"> </span> |
|
187 </td><td class="summary"> |
|
188 <a href="sysdef.api.TargetList-class.html" class="summary-name">TargetList</a><br /> |
|
189 Abstract targetlist from SDF file. |
|
190 </td> |
|
191 </tr> |
|
192 <tr> |
|
193 <td width="15%" align="right" valign="top" class="summary"> |
|
194 <span class="summary-type"> </span> |
|
195 </td><td class="summary"> |
|
196 <a href="sysdef.api.SystemDefinition-class.html" class="summary-name">SystemDefinition</a><br /> |
|
197 Logical representation of the System Definition. |
|
198 </td> |
|
199 </tr> |
|
200 <tr> |
|
201 <td width="15%" align="right" valign="top" class="summary"> |
|
202 <span class="summary-type"> </span> |
|
203 </td><td class="summary"> |
|
204 <a href="sysdef.api.Binary-class.html" class="summary-name">Binary</a><br /> |
|
205 A binary file that may go into a ROM image. |
|
206 </td> |
|
207 </tr> |
|
208 </table> |
|
209 <!-- ==================== FUNCTIONS ==================== --> |
|
210 <a name="section-Functions"></a> |
|
211 <table class="summary" border="1" cellpadding="3" |
|
212 cellspacing="0" width="100%" bgcolor="white"> |
|
213 <tr bgcolor="#70b0f0" class="table-header"> |
|
214 <td colspan="2" class="table-header"> |
|
215 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
216 <tr valign="top"> |
|
217 <td align="left"><span class="table-header">Functions</span></td> |
|
218 <td align="right" valign="top" |
|
219 ><span class="options">[<a href="#section-Functions" |
|
220 class="privatelink" onclick="toggle_private();" |
|
221 >hide private</a>]</span></td> |
|
222 </tr> |
|
223 </table> |
|
224 </td> |
|
225 </tr> |
|
226 <tr> |
|
227 <td width="15%" align="right" valign="top" class="summary"> |
|
228 <span class="summary-type"> </span> |
|
229 </td><td class="summary"> |
|
230 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
231 <tr> |
|
232 <td><span class="summary-sig"><a href="sysdef.api-module.html#filter_out" class="summary-sig-name">filter_out</a>(<span class="summary-sig-arg">config_filters</span>, |
|
233 <span class="summary-sig-arg">unit_filters</span>)</span><br /> |
|
234 Function that determines if a unit should be included or not.</td> |
|
235 <td align="right" valign="top"> |
|
236 <span class="codelink"><a href="sysdef.api-pysrc.html#filter_out">source code</a></span> |
|
237 |
|
238 </td> |
|
239 </tr> |
|
240 </table> |
|
241 |
|
242 </td> |
|
243 </tr> |
|
244 <tr> |
|
245 <td width="15%" align="right" valign="top" class="summary"> |
|
246 <span class="summary-type"> </span> |
|
247 </td><td class="summary"> |
|
248 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
249 <tr> |
|
250 <td><span class="summary-sig"><a href="sysdef.api-module.html#extract_filter_list" class="summary-sig-name">extract_filter_list</a>(<span class="summary-sig-arg">filters</span>)</span><br /> |
|
251 Convert a comma separated list of filters into a python list.</td> |
|
252 <td align="right" valign="top"> |
|
253 <span class="codelink"><a href="sysdef.api-pysrc.html#extract_filter_list">source code</a></span> |
|
254 |
|
255 </td> |
|
256 </tr> |
|
257 </table> |
|
258 |
|
259 </td> |
|
260 </tr> |
|
261 </table> |
|
262 <!-- ==================== VARIABLES ==================== --> |
|
263 <a name="section-Variables"></a> |
|
264 <table class="summary" border="1" cellpadding="3" |
|
265 cellspacing="0" width="100%" bgcolor="white"> |
|
266 <tr bgcolor="#70b0f0" class="table-header"> |
|
267 <td colspan="2" class="table-header"> |
|
268 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
269 <tr valign="top"> |
|
270 <td align="left"><span class="table-header">Variables</span></td> |
|
271 <td align="right" valign="top" |
|
272 ><span class="options">[<a href="#section-Variables" |
|
273 class="privatelink" onclick="toggle_private();" |
|
274 >hide private</a>]</span></td> |
|
275 </tr> |
|
276 </table> |
|
277 </td> |
|
278 </tr> |
|
279 <tr class="private"> |
|
280 <td width="15%" align="right" valign="top" class="summary"> |
|
281 <span class="summary-type"> </span> |
|
282 </td><td class="summary"> |
|
283 <a name="_logger"></a><span class="summary-name">_logger</span> = <code title="logging.getLogger('sysdef.api')">logging.getLogger('sysdef.api')</code> |
|
284 </td> |
|
285 </tr> |
|
286 </table> |
|
287 <!-- ==================== FUNCTION DETAILS ==================== --> |
|
288 <a name="section-FunctionDetails"></a> |
|
289 <table class="details" border="1" cellpadding="3" |
|
290 cellspacing="0" width="100%" bgcolor="white"> |
|
291 <tr bgcolor="#70b0f0" class="table-header"> |
|
292 <td colspan="2" class="table-header"> |
|
293 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
294 <tr valign="top"> |
|
295 <td align="left"><span class="table-header">Function Details</span></td> |
|
296 <td align="right" valign="top" |
|
297 ><span class="options">[<a href="#section-FunctionDetails" |
|
298 class="privatelink" onclick="toggle_private();" |
|
299 >hide private</a>]</span></td> |
|
300 </tr> |
|
301 </table> |
|
302 </td> |
|
303 </tr> |
|
304 </table> |
|
305 <a name="filter_out"></a> |
|
306 <div> |
|
307 <table class="details" border="1" cellpadding="3" |
|
308 cellspacing="0" width="100%" bgcolor="white"> |
|
309 <tr><td> |
|
310 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
311 <tr valign="top"><td> |
|
312 <h3 class="epydoc"><span class="sig"><span class="sig-name">filter_out</span>(<span class="sig-arg">config_filters</span>, |
|
313 <span class="sig-arg">unit_filters</span>)</span> |
|
314 </h3> |
|
315 </td><td align="right" valign="top" |
|
316 ><span class="codelink"><a href="sysdef.api-pysrc.html#filter_out">source code</a></span> |
|
317 </td> |
|
318 </table> |
|
319 |
|
320 Function that determines if a unit should be included or not. |
|
321 returns None => could be included, string reason. |
|
322 <dl class="fields"> |
|
323 </dl> |
|
324 </td></tr></table> |
|
325 </div> |
|
326 <a name="extract_filter_list"></a> |
|
327 <div> |
|
328 <table class="details" border="1" cellpadding="3" |
|
329 cellspacing="0" width="100%" bgcolor="white"> |
|
330 <tr><td> |
|
331 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
332 <tr valign="top"><td> |
|
333 <h3 class="epydoc"><span class="sig"><span class="sig-name">extract_filter_list</span>(<span class="sig-arg">filters</span>)</span> |
|
334 </h3> |
|
335 </td><td align="right" valign="top" |
|
336 ><span class="codelink"><a href="sysdef.api-pysrc.html#extract_filter_list">source code</a></span> |
|
337 </td> |
|
338 </table> |
|
339 |
|
340 Convert a comma separated list of filters into a python list. |
|
341 The method will skip empty filters (empty strings). |
|
342 <dl class="fields"> |
|
343 </dl> |
|
344 </td></tr></table> |
|
345 </div> |
|
346 <br /> |
|
347 <!-- ==================== NAVIGATION BAR ==================== --> |
|
348 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
349 bgcolor="#a0c0ff" cellspacing="0"> |
|
350 <tr valign="middle"> |
|
351 |
|
352 <!-- Tree link --> |
|
353 <th> <a |
|
354 href="module-tree.html">Trees</a> </th> |
|
355 |
|
356 <!-- Index link --> |
|
357 <th> <a |
|
358 href="identifier-index.html">Indices</a> </th> |
|
359 |
|
360 <!-- Help link --> |
|
361 <th> <a |
|
362 href="help.html">Help</a> </th> |
|
363 |
|
364 <th class="navbar" width="100%"></th> |
|
365 </tr> |
|
366 </table> |
|
367 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
368 <tr> |
|
369 <td align="left" class="footer"> |
|
370 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:16 2009 |
|
371 </td> |
|
372 <td align="right" class="footer"> |
|
373 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
374 </td> |
|
375 </tr> |
|
376 </table> |
|
377 |
|
378 <script type="text/javascript"> |
|
379 <!-- |
|
380 // Private objects are initially displayed (because if |
|
381 // javascript is turned off then we want them to be |
|
382 // visible); but by default, we want to hide them. So hide |
|
383 // them unless we have a cookie that says to show them. |
|
384 checkCookie() |
|
385 // --> |
|
386 </script> |
|
387 |
|
388 </body> |
|
389 </html> |