root/docs/private/cheesecake.CompositeIndex-class.html

Revision 2, 11.3 kB (checked in by grig, 7 years ago)

Initial import

Line 
1 <?xml version="1.0" encoding="iso-8859-1"?>
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>cheesecake.CompositeIndex</title>
7   <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
8 </head>
9 <body bgcolor="white" text="black" link="blue" vlink="#204080"
10       alink="#204080">
11
12 <!-- =========== START OF NAVBAR =========== -->
13 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
14   <tr valign="center">
15     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
16     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
17     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
18     <th class="navbar" align="right" width="100%">
19       <table border="0" cellpadding="0" cellspacing="0">
20       <tr><th class="navbar" align="center">
21         <p class="nomargin">
22           Cheesecake
23       </p></th></tr></table>
24     </th>
25   </tr>
26 </table>
27 <table width="100%" cellpadding="0" cellspacing="0">
28   <tr valign="top">
29     <td width="100%">
30       <font size="-1"><b class="breadcrumbs">
31         <a href="cheesecake-module.html">Module&nbsp;cheesecake</a> ::
32         Class&nbsp;CompositeIndex
33       </b></font></br>
34     </td>
35     <td><table cellpadding="0" cellspacing="0">
36       <tr><td align="right"><font size="-2">[show&nbsp;private&nbsp;|&nbsp;<a href="../public/cheesecake.CompositeIndex-class.html">hide&nbsp;private</a>]</font></td></tr>
37       <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="cheesecake.CompositeIndex-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
38     </table></td>
39 </tr></table>
40
41 <!-- =========== START OF CLASS DESCRIPTION =========== -->
42 <h2 class="class">Type CompositeIndex</h2>
43
44 <pre class="base-tree">
45 <a href="__builtin__.object-class.html"><code>object</code></a> --+
46          |
47         <b>CompositeIndex</b>
48 </pre><br />
49
50 <hr/>
51
52 <p>Collection of indexes of same type (e.g. files, dirs)</p>
53 <hr/>
54
55
56 <!-- =========== START OF METHOD SUMMARY =========== -->
57 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
58 <tr bgcolor="#70b0f0" class="summary">
59   <th colspan="2">Method Summary</th></tr>
60 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
61   <td><code><span class="summary-sig"><a href="cheesecake.CompositeIndex-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
62           <span class=summary-sig-arg>type</span>)</span></code>
63 <br />
64 Indexes is a dict mapping names to Index objects</td></tr>
65 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
66   <td><code><span class="summary-sig"><a href="cheesecake.CompositeIndex-class.html#get_value" class="summary-sig-name"><code>get_value</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
67 <br />
68 Return sum of individual index values</td></tr>
69 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
70   <td><code><span class="summary-sig"><a href="cheesecake.CompositeIndex-class.html#print_info" class="summary-sig-name"><code>print_info</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
71 <br />
72 Print index info for all indexes sorted alphanumerically by name</td></tr>
73 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
74   <td><code><span class="summary-sig"><a href="cheesecake.CompositeIndex-class.html#set_index" class="summary-sig-name"><code>set_index</code></a>(<span class=summary-sig-arg>self</span>,
75           <span class=summary-sig-arg>name</span>,
76           <span class=summary-sig-arg>value</span>,
77           <span class=summary-sig-arg>details</span>)</span></code>
78 <br />
79 Create new index or update existing index with specified attributes</td></tr>
80 <tr bgcolor="#e8f0f8" class="group">
81   <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from object</th></tr>
82 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
83   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
84 <br />
85 x.__delattr__('name') &lt;==&gt; del x.name</td></tr>
86 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
87   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
88 <br />
89 x.__getattribute__('name') &lt;==&gt; x.name</td></tr>
90 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
91   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
92 <br />
93 x.__hash__() &lt;==&gt; hash(x)</td></tr>
94 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
95   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>,
96           <span class=summary-sig-arg>S</span>,
97           <span class="summary-sig-vararg">...</span>)</span></code>
98 <br />
99 T.__new__(S, ...) -&gt; a new object with type S, a subtype of T</td></tr>
100 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
101   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
102 <br />
103 helper for pickle</td></tr>
104 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
105   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
106 <br />
107 helper for pickle</td></tr>
108 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
109   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
110 <br />
111 x.__repr__() &lt;==&gt; repr(x)</td></tr>
112 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
113   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
114 <br />
115 x.__setattr__('name', value) &lt;==&gt; x.name = value</td></tr>
116 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
117   <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
118 <br />
119 x.__str__() &lt;==&gt; str(x)</td></tr>
120 </table><br />
121
122
123 <!-- =========== START OF PROPERTY SUMMARY =========== -->
124 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
125 <tr bgcolor="#70b0f0" class="summary">
126   <th colspan="2">Property Summary</th></tr>
127 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
128   <td><b><a href="cheesecake.CompositeIndex-class.html#value"><code>value</code></a></b></td></tr></table><br />
129
130
131 <!-- =========== START OF METHOD DETAILS =========== -->
132 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
133 <tr bgcolor="#70b0f0" class="details">
134   <th colspan="2">Method Details</th></tr>
135 </table>
136
137 <a name="__init__"></a>
138 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
139   <h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
140           <span class=sig-arg>type</span>)</span>
141     <br /><i>(Constructor)</i>
142   </h3>
143 <p>Indexes is a dict mapping names to Index objects</p>
144   <dl><dt></dt><dd>
145     <dl><dt><b>Overrides:</b></dt>
146       <dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd>
147     </dl>
148   </dd></dl>
149 </td></tr></table>
150
151 <a name="get_value"></a>
152 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
153   <h3><span class="sig"><span class="sig-name">get_value</span>(<span class=sig-arg>self</span>)</span>
154   </h3>
155 <p>Return sum of individual index values</p>
156   <dl><dt></dt><dd>
157   </dd></dl>
158 </td></tr></table>
159
160 <a name="print_info"></a>
161 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
162   <h3><span class="sig"><span class="sig-name">print_info</span>(<span class=sig-arg>self</span>)</span>
163   </h3>
164 <p>Print index info for all indexes sorted alphanumerically by name</p>
165   <dl><dt></dt><dd>
166   </dd></dl>
167 </td></tr></table>
168
169 <a name="set_index"></a>
170 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
171   <h3><span class="sig"><span class="sig-name">set_index</span>(<span class=sig-arg>self</span>,
172           <span class=sig-arg>name</span>,
173           <span class=sig-arg>value</span>=<span class=sig-default>0</span>,
174           <span class=sig-arg>details</span>=<span class=sig-default>''</span>)</span>
175   </h3>
176 <p>Create new index or update existing index with specified attributes</p>
177   <dl><dt></dt><dd>
178   </dd></dl>
179 </td></tr></table>
180 <br />
181
182
183 <!-- =========== START OF PROPERTY DETAILS =========== -->
184 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
185 <tr bgcolor="#70b0f0" class="details">
186   <th colspan="2">Property Details</th></tr>
187 </table>
188 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
189
190 <a name="value"></a>
191 <h3>value</h3>
192 <dl>
193   <dt></dt>
194   <dd>
195     <dl>
196       <dt><b>Get Method:</b></dt>
197       <dd><span class="summary-sig"><a href="cheesecake.CompositeIndex-class.html#get_value" class="summary-sig-name"><code>get_value</code></a>(<span class=summary-sig-arg>self</span>)</span>
198       </dd>
199     </dl>
200   </dd>
201 </dl></td></tr></table><br />
202
203
204 <!-- =========== START OF NAVBAR =========== -->
205 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
206   <tr valign="center">
207     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
208     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
209     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
210     <th class="navbar" align="right" width="100%">
211       <table border="0" cellpadding="0" cellspacing="0">
212       <tr><th class="navbar" align="center">
213         <p class="nomargin">
214           Cheesecake
215       </p></th></tr></table>
216     </th>
217   </tr>
218 </table>
219
220 <table border="0" cellpadding="0" cellspacing="0" width="100%">
221   <tr>
222     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Wed Nov 16 09:59:23 2005</font></td>
223     <td align="right"><a href="http://epydoc.sourceforge.net"
224                       ><font size="-2">http://epydoc.sf.net</font></a></td>
225   </tr>
226 </table>
227 </body>
228 </html>
Note: See TracBrowser for help on using the browser.