|
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>virtualbuildarea.VirtualDir</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="virtualbuildarea-module.html">Module virtualbuildarea</a> :: |
|
38 Class VirtualDir |
|
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="virtualbuildarea.VirtualDir-class.html" |
|
49 target="_top">no frames</a>]</span></td></tr> |
|
50 </table> |
|
51 </td> |
|
52 </tr> |
|
53 </table> |
|
54 <!-- ==================== CLASS DESCRIPTION ==================== --> |
|
55 <h1 class="epydoc">Class VirtualDir</h1><span class="codelink"><a href="virtualbuildarea-pysrc.html#VirtualDir">source code</a></span><br /><br /> |
|
56 <pre class="base-tree"> |
|
57 object --+ |
|
58 | |
|
59 <a href="ccm.FourPartName-class.html">ccm.FourPartName</a> --+ |
|
60 | |
|
61 <a href="ccm.CCMObject-class.html">ccm.CCMObject</a> --+ |
|
62 | |
|
63 <a href="ccm.Dir-class.html">ccm.Dir</a> --+ |
|
64 | |
|
65 <strong class="uidshort">VirtualDir</strong> |
|
66 </pre> |
|
67 |
|
68 <hr /> |
|
69 Fake directory object. |
|
70 The four parts name will be: <dirname>-1:dir:fakedb#1<br /><br /> |
|
71 |
|
72 <!-- ==================== INSTANCE METHODS ==================== --> |
|
73 <a name="section-InstanceMethods"></a> |
|
74 <table class="summary" border="1" cellpadding="3" |
|
75 cellspacing="0" width="100%" bgcolor="white"> |
|
76 <tr bgcolor="#70b0f0" class="table-header"> |
|
77 <td colspan="2" class="table-header"> |
|
78 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
79 <tr valign="top"> |
|
80 <td align="left"><span class="table-header">Instance Methods</span></td> |
|
81 <td align="right" valign="top" |
|
82 ><span class="options">[<a href="#section-InstanceMethods" |
|
83 class="privatelink" onclick="toggle_private();" |
|
84 >hide private</a>]</span></td> |
|
85 </tr> |
|
86 </table> |
|
87 </td> |
|
88 </tr> |
|
89 <tr> |
|
90 <td width="15%" align="right" valign="top" class="summary"> |
|
91 <span class="summary-type"> </span> |
|
92 </td><td class="summary"> |
|
93 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
94 <tr> |
|
95 <td><span class="summary-sig"><a href="virtualbuildarea.VirtualDir-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
|
96 <span class="summary-sig-arg">session</span>, |
|
97 <span class="summary-sig-arg">name</span>, |
|
98 <span class="summary-sig-arg">project</span>)</span><br /> |
|
99 Create a FourPartName object based on a ifpn string.</td> |
|
100 <td align="right" valign="top"> |
|
101 <span class="codelink"><a href="virtualbuildarea-pysrc.html#VirtualDir.__init__">source code</a></span> |
|
102 |
|
103 </td> |
|
104 </tr> |
|
105 </table> |
|
106 |
|
107 </td> |
|
108 </tr> |
|
109 <tr> |
|
110 <td width="15%" align="right" valign="top" class="summary"> |
|
111 <span class="summary-type"> </span> |
|
112 </td><td class="summary"> |
|
113 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
114 <tr> |
|
115 <td><span class="summary-sig"><a name="addChild"></a><span class="summary-sig-name">addChild</span>(<span class="summary-sig-arg">self</span>, |
|
116 <span class="summary-sig-arg">o</span>, |
|
117 <span class="summary-sig-arg">project</span>)</span><br /> |
|
118 Add an object to the directory.</td> |
|
119 <td align="right" valign="top"> |
|
120 <span class="codelink"><a href="virtualbuildarea-pysrc.html#VirtualDir.addChild">source code</a></span> |
|
121 |
|
122 </td> |
|
123 </tr> |
|
124 </table> |
|
125 |
|
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 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
133 <tr> |
|
134 <td><span class="summary-sig"><a href="virtualbuildarea.VirtualDir-class.html#getDirNamed" class="summary-sig-name">getDirNamed</a>(<span class="summary-sig-arg">self</span>, |
|
135 <span class="summary-sig-arg">name</span>)</span><br /> |
|
136 Look for a subdirectory named in its children.</td> |
|
137 <td align="right" valign="top"> |
|
138 <span class="codelink"><a href="virtualbuildarea-pysrc.html#VirtualDir.getDirNamed">source code</a></span> |
|
139 |
|
140 </td> |
|
141 </tr> |
|
142 </table> |
|
143 |
|
144 </td> |
|
145 </tr> |
|
146 <tr> |
|
147 <td width="15%" align="right" valign="top" class="summary"> |
|
148 <span class="summary-type"> </span> |
|
149 </td><td class="summary"> |
|
150 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
151 <tr> |
|
152 <td><span class="summary-sig"><a href="virtualbuildarea.VirtualDir-class.html#children" class="summary-sig-name">children</a>(<span class="summary-sig-arg">self</span>, |
|
153 <span class="summary-sig-arg">project</span>)</span><br /> |
|
154 Returns a copy of the children list.</td> |
|
155 <td align="right" valign="top"> |
|
156 <span class="codelink"><a href="virtualbuildarea-pysrc.html#VirtualDir.children">source code</a></span> |
|
157 |
|
158 </td> |
|
159 </tr> |
|
160 </table> |
|
161 |
|
162 </td> |
|
163 </tr> |
|
164 <tr> |
|
165 <td width="15%" align="right" valign="top" class="summary"> |
|
166 <span class="summary-type"> </span> |
|
167 </td><td class="summary"> |
|
168 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
169 <tr> |
|
170 <td><span class="summary-sig"><a name="virtualproject"></a><span class="summary-sig-name">virtualproject</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
171 Return the associated virtual project.</td> |
|
172 <td align="right" valign="top"> |
|
173 <span class="codelink"><a href="virtualbuildarea-pysrc.html#VirtualDir.virtualproject">source code</a></span> |
|
174 |
|
175 </td> |
|
176 </tr> |
|
177 </table> |
|
178 |
|
179 </td> |
|
180 </tr> |
|
181 <tr> |
|
182 <td colspan="2" class="summary"> |
|
183 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.CCMObject-class.html">ccm.CCMObject</a></code></b>: |
|
184 <code><a href="ccm.CCMObject-class.html#__getitem__">__getitem__</a></code>, |
|
185 <code><a href="ccm.CCMObject-class.html#__setitem__">__setitem__</a></code>, |
|
186 <code><a href="ccm.CCMObject-class.html#create_attribute">create_attribute</a></code>, |
|
187 <code><a href="ccm.CCMObject-class.html#exists">exists</a></code>, |
|
188 <code><a href="ccm.CCMObject-class.html#finduse">finduse</a></code>, |
|
189 <code><a href="ccm.CCMObject-class.html#is_predecessor_of">is_predecessor_of</a></code>, |
|
190 <code><a href="ccm.CCMObject-class.html#is_recursive_predecessor_of">is_recursive_predecessor_of</a></code>, |
|
191 <code><a href="ccm.CCMObject-class.html#is_recursive_predecessor_of_fast">is_recursive_predecessor_of_fast</a></code>, |
|
192 <code><a href="ccm.CCMObject-class.html#is_recursive_successor_of_fast">is_recursive_successor_of_fast</a></code>, |
|
193 <code><a href="ccm.CCMObject-class.html#is_recursive_sucessor_of">is_recursive_sucessor_of</a></code>, |
|
194 <code><a href="ccm.CCMObject-class.html#keys">keys</a></code>, |
|
195 <code><a href="ccm.CCMObject-class.html#predecessors">predecessors</a></code>, |
|
196 <code><a href="ccm.CCMObject-class.html#relate">relate</a></code>, |
|
197 <code><a href="ccm.CCMObject-class.html#session">session</a></code>, |
|
198 <code><a href="ccm.CCMObject-class.html#successors">successors</a></code> |
|
199 </p> |
|
200 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.CCMObject-class.html">ccm.CCMObject</a></code></b> (private): |
|
201 <code><a href="ccm.CCMObject-class.html#_getsession">_getsession</a></code> |
|
202 </p></div> |
|
203 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.FourPartName-class.html">ccm.FourPartName</a></code></b>: |
|
204 <code><a href="ccm.FourPartName-class.html#__eq__">__eq__</a></code>, |
|
205 <code><a href="ccm.FourPartName-class.html#__ne__">__ne__</a></code>, |
|
206 <code><a href="ccm.FourPartName-class.html#__repr__">__repr__</a></code>, |
|
207 <code><a href="ccm.FourPartName-class.html#__str__">__str__</a></code>, |
|
208 <code><a href="ccm.FourPartName-class.html#family">family</a></code>, |
|
209 <code><a href="ccm.FourPartName-class.html#instance">instance</a></code>, |
|
210 <code><a href="ccm.FourPartName-class.html#is_same_family">is_same_family</a></code>, |
|
211 <code><a href="ccm.FourPartName-class.html#name">name</a></code>, |
|
212 <code><a href="ccm.FourPartName-class.html#objectname">objectname</a></code>, |
|
213 <code><a href="ccm.FourPartName-class.html#type">type</a></code>, |
|
214 <code><a href="ccm.FourPartName-class.html#version">version</a></code> |
|
215 </p> |
|
216 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
217 <code>__delattr__</code>, |
|
218 <code>__getattribute__</code>, |
|
219 <code>__hash__</code>, |
|
220 <code>__new__</code>, |
|
221 <code>__reduce__</code>, |
|
222 <code>__reduce_ex__</code>, |
|
223 <code>__setattr__</code> |
|
224 </p> |
|
225 </td> |
|
226 </tr> |
|
227 </table> |
|
228 <!-- ==================== STATIC METHODS ==================== --> |
|
229 <a name="section-StaticMethods"></a> |
|
230 <table class="summary" border="1" cellpadding="3" |
|
231 cellspacing="0" width="100%" bgcolor="white"> |
|
232 <tr bgcolor="#70b0f0" class="table-header"> |
|
233 <td colspan="2" class="table-header"> |
|
234 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
235 <tr valign="top"> |
|
236 <td align="left"><span class="table-header">Static Methods</span></td> |
|
237 <td align="right" valign="top" |
|
238 ><span class="options">[<a href="#section-StaticMethods" |
|
239 class="privatelink" onclick="toggle_private();" |
|
240 >hide private</a>]</span></td> |
|
241 </tr> |
|
242 </table> |
|
243 </td> |
|
244 </tr> |
|
245 <tr> |
|
246 <td colspan="2" class="summary"> |
|
247 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.FourPartName-class.html">ccm.FourPartName</a></code></b>: |
|
248 <code><a href="ccm.FourPartName-class.html#convert">convert</a></code>, |
|
249 <code><a href="ccm.FourPartName-class.html#is_valid">is_valid</a></code> |
|
250 </p> |
|
251 </td> |
|
252 </tr> |
|
253 </table> |
|
254 <!-- ==================== PROPERTIES ==================== --> |
|
255 <a name="section-Properties"></a> |
|
256 <table class="summary" border="1" cellpadding="3" |
|
257 cellspacing="0" width="100%" bgcolor="white"> |
|
258 <tr bgcolor="#70b0f0" class="table-header"> |
|
259 <td colspan="2" class="table-header"> |
|
260 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
261 <tr valign="top"> |
|
262 <td align="left"><span class="table-header">Properties</span></td> |
|
263 <td align="right" valign="top" |
|
264 ><span class="options">[<a href="#section-Properties" |
|
265 class="privatelink" onclick="toggle_private();" |
|
266 >hide private</a>]</span></td> |
|
267 </tr> |
|
268 </table> |
|
269 </td> |
|
270 </tr> |
|
271 <tr> |
|
272 <td colspan="2" class="summary"> |
|
273 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
274 <code>__class__</code> |
|
275 </p> |
|
276 </td> |
|
277 </tr> |
|
278 </table> |
|
279 <!-- ==================== METHOD DETAILS ==================== --> |
|
280 <a name="section-MethodDetails"></a> |
|
281 <table class="details" border="1" cellpadding="3" |
|
282 cellspacing="0" width="100%" bgcolor="white"> |
|
283 <tr bgcolor="#70b0f0" class="table-header"> |
|
284 <td colspan="2" class="table-header"> |
|
285 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
286 <tr valign="top"> |
|
287 <td align="left"><span class="table-header">Method Details</span></td> |
|
288 <td align="right" valign="top" |
|
289 ><span class="options">[<a href="#section-MethodDetails" |
|
290 class="privatelink" onclick="toggle_private();" |
|
291 >hide private</a>]</span></td> |
|
292 </tr> |
|
293 </table> |
|
294 </td> |
|
295 </tr> |
|
296 </table> |
|
297 <a name="__init__"></a> |
|
298 <div> |
|
299 <table class="details" border="1" cellpadding="3" |
|
300 cellspacing="0" width="100%" bgcolor="white"> |
|
301 <tr><td> |
|
302 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
303 <tr valign="top"><td> |
|
304 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
|
305 <span class="sig-arg">session</span>, |
|
306 <span class="sig-arg">name</span>, |
|
307 <span class="sig-arg">project</span>)</span> |
|
308 <br /><em class="fname">(Constructor)</em> |
|
309 </h3> |
|
310 </td><td align="right" valign="top" |
|
311 ><span class="codelink"><a href="virtualbuildarea-pysrc.html#VirtualDir.__init__">source code</a></span> |
|
312 </td> |
|
313 </table> |
|
314 |
|
315 <p>Create a FourPartName object based on a ifpn string.</p> |
|
316 <p>The string have to match the following patterns: |
|
317 - name-version:type:instance |
|
318 - name:version:releasedef:instance |
|
319 - Task database#id |
|
320 - Folder database#id</p> |
|
321 <p>Anything else is considered as old release string format.</p> |
|
322 <dl class="fields"> |
|
323 <dt>Overrides: |
|
324 <a href="ccm.Dir-class.html#__init__">ccm.Dir.__init__</a> |
|
325 </dt> |
|
326 </dl> |
|
327 </td></tr></table> |
|
328 </div> |
|
329 <a name="getDirNamed"></a> |
|
330 <div> |
|
331 <table class="details" border="1" cellpadding="3" |
|
332 cellspacing="0" width="100%" bgcolor="white"> |
|
333 <tr><td> |
|
334 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
335 <tr valign="top"><td> |
|
336 <h3 class="epydoc"><span class="sig"><span class="sig-name">getDirNamed</span>(<span class="sig-arg">self</span>, |
|
337 <span class="sig-arg">name</span>)</span> |
|
338 </h3> |
|
339 </td><td align="right" valign="top" |
|
340 ><span class="codelink"><a href="virtualbuildarea-pysrc.html#VirtualDir.getDirNamed">source code</a></span> |
|
341 </td> |
|
342 </table> |
|
343 |
|
344 Look for a subdirectory named in its children. |
|
345 The test is done in a case insensitive way. |
|
346 <dl class="fields"> |
|
347 </dl> |
|
348 </td></tr></table> |
|
349 </div> |
|
350 <a name="children"></a> |
|
351 <div> |
|
352 <table class="details" border="1" cellpadding="3" |
|
353 cellspacing="0" width="100%" bgcolor="white"> |
|
354 <tr><td> |
|
355 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
356 <tr valign="top"><td> |
|
357 <h3 class="epydoc"><span class="sig"><span class="sig-name">children</span>(<span class="sig-arg">self</span>, |
|
358 <span class="sig-arg">project</span>)</span> |
|
359 </h3> |
|
360 </td><td align="right" valign="top" |
|
361 ><span class="codelink"><a href="virtualbuildarea-pysrc.html#VirtualDir.children">source code</a></span> |
|
362 </td> |
|
363 </table> |
|
364 |
|
365 Returns a copy of the children list. |
|
366 <dl class="fields"> |
|
367 <dt>Overrides: |
|
368 <a href="ccm.Dir-class.html#children">ccm.Dir.children</a> |
|
369 </dt> |
|
370 </dl> |
|
371 </td></tr></table> |
|
372 </div> |
|
373 <br /> |
|
374 <!-- ==================== NAVIGATION BAR ==================== --> |
|
375 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
376 bgcolor="#a0c0ff" cellspacing="0"> |
|
377 <tr valign="middle"> |
|
378 |
|
379 <!-- Tree link --> |
|
380 <th> <a |
|
381 href="module-tree.html">Trees</a> </th> |
|
382 |
|
383 <!-- Index link --> |
|
384 <th> <a |
|
385 href="identifier-index.html">Indices</a> </th> |
|
386 |
|
387 <!-- Help link --> |
|
388 <th> <a |
|
389 href="help.html">Help</a> </th> |
|
390 |
|
391 <th class="navbar" width="100%"></th> |
|
392 </tr> |
|
393 </table> |
|
394 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
395 <tr> |
|
396 <td align="left" class="footer"> |
|
397 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:19 2009 |
|
398 </td> |
|
399 <td align="right" class="footer"> |
|
400 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
401 </td> |
|
402 </tr> |
|
403 </table> |
|
404 |
|
405 <script type="text/javascript"> |
|
406 <!-- |
|
407 // Private objects are initially displayed (because if |
|
408 // javascript is turned off then we want them to be |
|
409 // visible); but by default, we want to hide them. So hide |
|
410 // them unless we have a cookie that says to show them. |
|
411 checkCookie() |
|
412 // --> |
|
413 </script> |
|
414 |
|
415 </body> |
|
416 </html> |