|
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>ccm.Dir</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="ccm-module.html">Package ccm</a> :: |
|
38 Class Dir |
|
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="ccm.Dir-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 Dir</h1><span class="codelink"><a href="ccm-pysrc.html#Dir">source code</a></span><br /><br /> |
|
56 <pre class="base-tree"> |
|
57 object --+ |
|
58 | |
|
59 <a href="ccm.FourPartName-class.html">FourPartName</a> --+ |
|
60 | |
|
61 <a href="ccm.CCMObject-class.html">CCMObject</a> --+ |
|
62 | |
|
63 <strong class="uidshort">Dir</strong> |
|
64 </pre> |
|
65 |
|
66 <hr /> |
|
67 Wrapper class for Synergy dir object<br /><br /> |
|
68 |
|
69 <!-- ==================== INSTANCE METHODS ==================== --> |
|
70 <a name="section-InstanceMethods"></a> |
|
71 <table class="summary" border="1" cellpadding="3" |
|
72 cellspacing="0" width="100%" bgcolor="white"> |
|
73 <tr bgcolor="#70b0f0" class="table-header"> |
|
74 <td colspan="2" class="table-header"> |
|
75 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
76 <tr valign="top"> |
|
77 <td align="left"><span class="table-header">Instance Methods</span></td> |
|
78 <td align="right" valign="top" |
|
79 ><span class="options">[<a href="#section-InstanceMethods" |
|
80 class="privatelink" onclick="toggle_private();" |
|
81 >hide private</a>]</span></td> |
|
82 </tr> |
|
83 </table> |
|
84 </td> |
|
85 </tr> |
|
86 <tr> |
|
87 <td width="15%" align="right" valign="top" class="summary"> |
|
88 <span class="summary-type"> </span> |
|
89 </td><td class="summary"> |
|
90 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
91 <tr> |
|
92 <td><span class="summary-sig"><a href="ccm.Dir-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
|
93 <span class="summary-sig-arg">session</span>, |
|
94 <span class="summary-sig-arg">fpn</span>)</span><br /> |
|
95 Create a FourPartName object based on a ifpn string.</td> |
|
96 <td align="right" valign="top"> |
|
97 <span class="codelink"><a href="ccm-pysrc.html#Dir.__init__">source code</a></span> |
|
98 |
|
99 </td> |
|
100 </tr> |
|
101 </table> |
|
102 |
|
103 </td> |
|
104 </tr> |
|
105 <tr> |
|
106 <td width="15%" align="right" valign="top" class="summary"> |
|
107 <span class="summary-type"> </span> |
|
108 </td><td class="summary"> |
|
109 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
110 <tr> |
|
111 <td><span class="summary-sig"><a name="children"></a><span class="summary-sig-name">children</span>(<span class="summary-sig-arg">self</span>, |
|
112 <span class="summary-sig-arg">project</span>)</span></td> |
|
113 <td align="right" valign="top"> |
|
114 <span class="codelink"><a href="ccm-pysrc.html#Dir.children">source code</a></span> |
|
115 |
|
116 </td> |
|
117 </tr> |
|
118 </table> |
|
119 |
|
120 </td> |
|
121 </tr> |
|
122 <tr> |
|
123 <td colspan="2" class="summary"> |
|
124 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.CCMObject-class.html">CCMObject</a></code></b>: |
|
125 <code><a href="ccm.CCMObject-class.html#__getitem__">__getitem__</a></code>, |
|
126 <code><a href="ccm.CCMObject-class.html#__setitem__">__setitem__</a></code>, |
|
127 <code><a href="ccm.CCMObject-class.html#create_attribute">create_attribute</a></code>, |
|
128 <code><a href="ccm.CCMObject-class.html#exists">exists</a></code>, |
|
129 <code><a href="ccm.CCMObject-class.html#finduse">finduse</a></code>, |
|
130 <code><a href="ccm.CCMObject-class.html#is_predecessor_of">is_predecessor_of</a></code>, |
|
131 <code><a href="ccm.CCMObject-class.html#is_recursive_predecessor_of">is_recursive_predecessor_of</a></code>, |
|
132 <code><a href="ccm.CCMObject-class.html#is_recursive_predecessor_of_fast">is_recursive_predecessor_of_fast</a></code>, |
|
133 <code><a href="ccm.CCMObject-class.html#is_recursive_successor_of_fast">is_recursive_successor_of_fast</a></code>, |
|
134 <code><a href="ccm.CCMObject-class.html#is_recursive_sucessor_of">is_recursive_sucessor_of</a></code>, |
|
135 <code><a href="ccm.CCMObject-class.html#keys">keys</a></code>, |
|
136 <code><a href="ccm.CCMObject-class.html#predecessors">predecessors</a></code>, |
|
137 <code><a href="ccm.CCMObject-class.html#relate">relate</a></code>, |
|
138 <code><a href="ccm.CCMObject-class.html#session">session</a></code>, |
|
139 <code><a href="ccm.CCMObject-class.html#successors">successors</a></code> |
|
140 </p> |
|
141 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.CCMObject-class.html">CCMObject</a></code></b> (private): |
|
142 <code><a href="ccm.CCMObject-class.html#_getsession">_getsession</a></code> |
|
143 </p></div> |
|
144 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.FourPartName-class.html">FourPartName</a></code></b>: |
|
145 <code><a href="ccm.FourPartName-class.html#__eq__">__eq__</a></code>, |
|
146 <code><a href="ccm.FourPartName-class.html#__ne__">__ne__</a></code>, |
|
147 <code><a href="ccm.FourPartName-class.html#__repr__">__repr__</a></code>, |
|
148 <code><a href="ccm.FourPartName-class.html#__str__">__str__</a></code>, |
|
149 <code><a href="ccm.FourPartName-class.html#family">family</a></code>, |
|
150 <code><a href="ccm.FourPartName-class.html#instance">instance</a></code>, |
|
151 <code><a href="ccm.FourPartName-class.html#is_same_family">is_same_family</a></code>, |
|
152 <code><a href="ccm.FourPartName-class.html#name">name</a></code>, |
|
153 <code><a href="ccm.FourPartName-class.html#objectname">objectname</a></code>, |
|
154 <code><a href="ccm.FourPartName-class.html#type">type</a></code>, |
|
155 <code><a href="ccm.FourPartName-class.html#version">version</a></code> |
|
156 </p> |
|
157 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
158 <code>__delattr__</code>, |
|
159 <code>__getattribute__</code>, |
|
160 <code>__hash__</code>, |
|
161 <code>__new__</code>, |
|
162 <code>__reduce__</code>, |
|
163 <code>__reduce_ex__</code>, |
|
164 <code>__setattr__</code> |
|
165 </p> |
|
166 </td> |
|
167 </tr> |
|
168 </table> |
|
169 <!-- ==================== STATIC METHODS ==================== --> |
|
170 <a name="section-StaticMethods"></a> |
|
171 <table class="summary" border="1" cellpadding="3" |
|
172 cellspacing="0" width="100%" bgcolor="white"> |
|
173 <tr bgcolor="#70b0f0" class="table-header"> |
|
174 <td colspan="2" class="table-header"> |
|
175 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
176 <tr valign="top"> |
|
177 <td align="left"><span class="table-header">Static Methods</span></td> |
|
178 <td align="right" valign="top" |
|
179 ><span class="options">[<a href="#section-StaticMethods" |
|
180 class="privatelink" onclick="toggle_private();" |
|
181 >hide private</a>]</span></td> |
|
182 </tr> |
|
183 </table> |
|
184 </td> |
|
185 </tr> |
|
186 <tr> |
|
187 <td colspan="2" class="summary"> |
|
188 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.FourPartName-class.html">FourPartName</a></code></b>: |
|
189 <code><a href="ccm.FourPartName-class.html#convert">convert</a></code>, |
|
190 <code><a href="ccm.FourPartName-class.html#is_valid">is_valid</a></code> |
|
191 </p> |
|
192 </td> |
|
193 </tr> |
|
194 </table> |
|
195 <!-- ==================== PROPERTIES ==================== --> |
|
196 <a name="section-Properties"></a> |
|
197 <table class="summary" border="1" cellpadding="3" |
|
198 cellspacing="0" width="100%" bgcolor="white"> |
|
199 <tr bgcolor="#70b0f0" class="table-header"> |
|
200 <td colspan="2" class="table-header"> |
|
201 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
202 <tr valign="top"> |
|
203 <td align="left"><span class="table-header">Properties</span></td> |
|
204 <td align="right" valign="top" |
|
205 ><span class="options">[<a href="#section-Properties" |
|
206 class="privatelink" onclick="toggle_private();" |
|
207 >hide private</a>]</span></td> |
|
208 </tr> |
|
209 </table> |
|
210 </td> |
|
211 </tr> |
|
212 <tr> |
|
213 <td colspan="2" class="summary"> |
|
214 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
215 <code>__class__</code> |
|
216 </p> |
|
217 </td> |
|
218 </tr> |
|
219 </table> |
|
220 <!-- ==================== METHOD DETAILS ==================== --> |
|
221 <a name="section-MethodDetails"></a> |
|
222 <table class="details" border="1" cellpadding="3" |
|
223 cellspacing="0" width="100%" bgcolor="white"> |
|
224 <tr bgcolor="#70b0f0" class="table-header"> |
|
225 <td colspan="2" class="table-header"> |
|
226 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
227 <tr valign="top"> |
|
228 <td align="left"><span class="table-header">Method Details</span></td> |
|
229 <td align="right" valign="top" |
|
230 ><span class="options">[<a href="#section-MethodDetails" |
|
231 class="privatelink" onclick="toggle_private();" |
|
232 >hide private</a>]</span></td> |
|
233 </tr> |
|
234 </table> |
|
235 </td> |
|
236 </tr> |
|
237 </table> |
|
238 <a name="__init__"></a> |
|
239 <div> |
|
240 <table class="details" border="1" cellpadding="3" |
|
241 cellspacing="0" width="100%" bgcolor="white"> |
|
242 <tr><td> |
|
243 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
244 <tr valign="top"><td> |
|
245 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
|
246 <span class="sig-arg">session</span>, |
|
247 <span class="sig-arg">fpn</span>)</span> |
|
248 <br /><em class="fname">(Constructor)</em> |
|
249 </h3> |
|
250 </td><td align="right" valign="top" |
|
251 ><span class="codelink"><a href="ccm-pysrc.html#Dir.__init__">source code</a></span> |
|
252 </td> |
|
253 </table> |
|
254 |
|
255 <p>Create a FourPartName object based on a ifpn string.</p> |
|
256 <p>The string have to match the following patterns: |
|
257 - name-version:type:instance |
|
258 - name:version:releasedef:instance |
|
259 - Task database#id |
|
260 - Folder database#id</p> |
|
261 <p>Anything else is considered as old release string format.</p> |
|
262 <dl class="fields"> |
|
263 <dt>Overrides: |
|
264 <a href="ccm.CCMObject-class.html#__init__">CCMObject.__init__</a> |
|
265 </dt> |
|
266 </dl> |
|
267 </td></tr></table> |
|
268 </div> |
|
269 <br /> |
|
270 <!-- ==================== NAVIGATION BAR ==================== --> |
|
271 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
272 bgcolor="#a0c0ff" cellspacing="0"> |
|
273 <tr valign="middle"> |
|
274 |
|
275 <!-- Tree link --> |
|
276 <th> <a |
|
277 href="module-tree.html">Trees</a> </th> |
|
278 |
|
279 <!-- Index link --> |
|
280 <th> <a |
|
281 href="identifier-index.html">Indices</a> </th> |
|
282 |
|
283 <!-- Help link --> |
|
284 <th> <a |
|
285 href="help.html">Help</a> </th> |
|
286 |
|
287 <th class="navbar" width="100%"></th> |
|
288 </tr> |
|
289 </table> |
|
290 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
291 <tr> |
|
292 <td align="left" class="footer"> |
|
293 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009 |
|
294 </td> |
|
295 <td align="right" class="footer"> |
|
296 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
297 </td> |
|
298 </tr> |
|
299 </table> |
|
300 |
|
301 <script type="text/javascript"> |
|
302 <!-- |
|
303 // Private objects are initially displayed (because if |
|
304 // javascript is turned off then we want them to be |
|
305 // visible); but by default, we want to hide them. So hide |
|
306 // them unless we have a cookie that says to show them. |
|
307 checkCookie() |
|
308 // --> |
|
309 </script> |
|
310 |
|
311 </body> |
|
312 </html> |