projects / OpenSPARC-T2-SAM / blame
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / v8plus / html / python / lib / mh-folder-objects.html
CommitLineData
920dae64
AT		 1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html>
3<head>
4<link rel="STYLESHEET" href="lib.css" type='text/css' />
5<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
6<link rel='start' href='../index.html' title='Python Documentation Index' />
7<link rel="first" href="lib.html" title='Python Library Reference' />
8<link rel='contents' href='contents.html' title="Contents" />
9<link rel='index' href='genindex.html' title='Index' />
10<link rel='last' href='about.html' title='About this document...' />
11<link rel='help' href='about.html' title='About this document...' />
12<link rel="next" href="mh-message-objects.html" />
13<link rel="prev" href="mh-objects.html" />
14<link rel="parent" href="module-mhlib.html" />
15<link rel="next" href="mh-message-objects.html" />
16<meta name='aesop' content='information' />
17<title>12.5.2 Folder Objects </title>
18</head>
19<body>
20<DIV CLASS="navigation">
21<div id='top-navigation-panel' xml:id='top-navigation-panel'>
22<table align="center" width="100%" cellpadding="0" cellspacing="2">
23<tr>
24<td class='online-navigation'><a rel="prev" title="12.5.1 MH Objects"
25 href="mh-objects.html"><img src='../icons/previous.png'
26 border='0' height='32' alt='Previous Page' width='32' /></A></td>
27<td class='online-navigation'><a rel="parent" title="12.5 mhlib "
28 href="module-mhlib.html"><img src='../icons/up.png'
29 border='0' height='32' alt='Up One Level' width='32' /></A></td>
30<td class='online-navigation'><a rel="next" title="12.5.3 Message Objects"
31 href="mh-message-objects.html"><img src='../icons/next.png'
32 border='0' height='32' alt='Next Page' width='32' /></A></td>
33<td align="center" width="100%">Python Library Reference</td>
34<td class='online-navigation'><a rel="contents" title="Table of Contents"
35 href="contents.html"><img src='../icons/contents.png'
36 border='0' height='32' alt='Contents' width='32' /></A></td>
37<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
38 border='0' height='32' alt='Module Index' width='32' /></a></td>
39<td class='online-navigation'><a rel="index" title="Index"
40 href="genindex.html"><img src='../icons/index.png'
41 border='0' height='32' alt='Index' width='32' /></A></td>
42</tr></table>
43<div class='online-navigation'>
44<b class="navlabel">Previous:</b>
45<a class="sectref" rel="prev" href="mh-objects.html">12.5.1 MH Objects</A>
46<b class="navlabel">Up:</b>
47<a class="sectref" rel="parent" href="module-mhlib.html">12.5 mhlib </A>
48<b class="navlabel">Next:</b>
49<a class="sectref" rel="next" href="mh-message-objects.html">12.5.3 Message Objects</A>
50</div>
51<hr /></div>
52</DIV>
53<!--End of Navigation Panel-->
54
55<H2><A NAME="SECTION0014520000000000000000"></A><A NAME="mh-folder-objects"></A>
56<BR>
5712.5.2 Folder Objects
58</H2>
59
60<P>
61<tt class="class">Folder</tt> instances represent open folders and have the following
62methods:
63
64<P>
65<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
66 <td><nobr><b><tt id='l2h-3987' xml:id='l2h-3987' class="method">error</tt></b>(</nobr></td>
67 <td><var>format</var><big>[</big><var>, ...</var><big>]</big><var></var>)</td></tr></table></dt>
68<dd>
69Print an error message - can be overridden.
70</dl>
71
72<P>
73<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
74 <td><nobr><b><tt id='l2h-3988' xml:id='l2h-3988' class="method">getfullname</tt></b>(</nobr></td>
75 <td><var></var>)</td></tr></table></dt>
76<dd>
77Return the folder's full pathname.
78</dl>
79
80<P>
81<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
82 <td><nobr><b><tt id='l2h-3989' xml:id='l2h-3989' class="method">getsequencesfilename</tt></b>(</nobr></td>
83 <td><var></var>)</td></tr></table></dt>
84<dd>
85Return the full pathname of the folder's sequences file.
86</dl>
87
88<P>
89<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
90 <td><nobr><b><tt id='l2h-3990' xml:id='l2h-3990' class="method">getmessagefilename</tt></b>(</nobr></td>
91 <td><var>n</var>)</td></tr></table></dt>
92<dd>
93Return the full pathname of message <var>n</var> of the folder.
94</dl>
95
96<P>
97<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
98 <td><nobr><b><tt id='l2h-3991' xml:id='l2h-3991' class="method">listmessages</tt></b>(</nobr></td>
99 <td><var></var>)</td></tr></table></dt>
100<dd>
101Return a list of messages in the folder (as numbers).
102</dl>
103
104<P>
105<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
106 <td><nobr><b><tt id='l2h-3992' xml:id='l2h-3992' class="method">getcurrent</tt></b>(</nobr></td>
107 <td><var></var>)</td></tr></table></dt>
108<dd>
109Return the current message number.
110</dl>
111
112<P>
113<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
114 <td><nobr><b><tt id='l2h-3993' xml:id='l2h-3993' class="method">setcurrent</tt></b>(</nobr></td>
115 <td><var>n</var>)</td></tr></table></dt>
116<dd>
117Set the current message number to <var>n</var>.
118</dl>
119
120<P>
121<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
122 <td><nobr><b><tt id='l2h-3994' xml:id='l2h-3994' class="method">parsesequence</tt></b>(</nobr></td>
123 <td><var>seq</var>)</td></tr></table></dt>
124<dd>
125Parse msgs syntax into list of messages.
126</dl>
127
128<P>
129<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
130 <td><nobr><b><tt id='l2h-3995' xml:id='l2h-3995' class="method">getlast</tt></b>(</nobr></td>
131 <td><var></var>)</td></tr></table></dt>
132<dd>
133Get last message, or <code>0</code> if no messages are in the folder.
134</dl>
135
136<P>
137<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
138 <td><nobr><b><tt id='l2h-3996' xml:id='l2h-3996' class="method">setlast</tt></b>(</nobr></td>
139 <td><var>n</var>)</td></tr></table></dt>
140<dd>
141Set last message (internal use only).
142</dl>
143
144<P>
145<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
146 <td><nobr><b><tt id='l2h-3997' xml:id='l2h-3997' class="method">getsequences</tt></b>(</nobr></td>
147 <td><var></var>)</td></tr></table></dt>
148<dd>
149Return dictionary of sequences in folder. The sequence names are used
150as keys, and the values are the lists of message numbers in the
151sequences.
152</dl>
153
154<P>
155<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
156 <td><nobr><b><tt id='l2h-3998' xml:id='l2h-3998' class="method">putsequences</tt></b>(</nobr></td>
157 <td><var>dict</var>)</td></tr></table></dt>
158<dd>
159Return dictionary of sequences in folder name: list.
160</dl>
161
162<P>
163<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
164 <td><nobr><b><tt id='l2h-3999' xml:id='l2h-3999' class="method">removemessages</tt></b>(</nobr></td>
165 <td><var>list</var>)</td></tr></table></dt>
166<dd>
167Remove messages in list from folder.
168</dl>
169
170<P>
171<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
172 <td><nobr><b><tt id='l2h-4000' xml:id='l2h-4000' class="method">refilemessages</tt></b>(</nobr></td>
173 <td><var>list, tofolder</var>)</td></tr></table></dt>
174<dd>
175Move messages in list to other folder.
176</dl>
177
178<P>
179<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
180 <td><nobr><b><tt id='l2h-4001' xml:id='l2h-4001' class="method">movemessage</tt></b>(</nobr></td>
181 <td><var>n, tofolder, ton</var>)</td></tr></table></dt>
182<dd>
183Move one message to a given destination in another folder.
184</dl>
185
186<P>
187<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
188 <td><nobr><b><tt id='l2h-4002' xml:id='l2h-4002' class="method">copymessage</tt></b>(</nobr></td>
189 <td><var>n, tofolder, ton</var>)</td></tr></table></dt>
190<dd>
191Copy one message to a given destination in another folder.
192</dl>
193
194<P>
195
196<DIV CLASS="navigation">
197<div class='online-navigation'>
198<p></p><hr />
199<table align="center" width="100%" cellpadding="0" cellspacing="2">
200<tr>
201<td class='online-navigation'><a rel="prev" title="12.5.1 MH Objects"
202 href="mh-objects.html"><img src='../icons/previous.png'
203 border='0' height='32' alt='Previous Page' width='32' /></A></td>
204<td class='online-navigation'><a rel="parent" title="12.5 mhlib "
205 href="module-mhlib.html"><img src='../icons/up.png'
206 border='0' height='32' alt='Up One Level' width='32' /></A></td>
207<td class='online-navigation'><a rel="next" title="12.5.3 Message Objects"
208 href="mh-message-objects.html"><img src='../icons/next.png'
209 border='0' height='32' alt='Next Page' width='32' /></A></td>
210<td align="center" width="100%">Python Library Reference</td>
211<td class='online-navigation'><a rel="contents" title="Table of Contents"
212 href="contents.html"><img src='../icons/contents.png'
213 border='0' height='32' alt='Contents' width='32' /></A></td>
214<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
215 border='0' height='32' alt='Module Index' width='32' /></a></td>
216<td class='online-navigation'><a rel="index" title="Index"
217 href="genindex.html"><img src='../icons/index.png'
218 border='0' height='32' alt='Index' width='32' /></A></td>
219</tr></table>
220<div class='online-navigation'>
221<b class="navlabel">Previous:</b>
222<a class="sectref" rel="prev" href="mh-objects.html">12.5.1 MH Objects</A>
223<b class="navlabel">Up:</b>
224<a class="sectref" rel="parent" href="module-mhlib.html">12.5 mhlib </A>
225<b class="navlabel">Next:</b>
226<a class="sectref" rel="next" href="mh-message-objects.html">12.5.3 Message Objects</A>
227</div>
228</div>
229<hr />
230<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
231</DIV>
232<!--End of Navigation Panel-->
233<ADDRESS>
234See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
235</ADDRESS>
236</BODY>
237</HTML>
Full OpenSPARC architecture tarball including simulator, hypervisor, and OBP.