mirror of
https://github.com/miky-kr5/NXT-Dev-Kits.git
synced 2023-01-29 18:47:06 +00:00
203 lines
9.4 KiB
HTML
Executable File
203 lines
9.4 KiB
HTML
Executable File
<html><body>
|
|
|
|
<!-- Generated by Doxygen 1.2.11.1 -->
|
|
<center>
|
|
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> </center>
|
|
<hr><h1>nFANTOM100::iFileIterator Class Reference</h1>Interface to an iterator for files on a LEGO MINDSTORMS NXT.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="iFileIterator_8h-source.html">iFileIterator.h</a>></code>
|
|
<p>
|
|
<a href="classnFANTOM100_1_1iFileIterator-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
|
|
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top>virtual <a class="el" href="classnFANTOM100_1_1iFile.html">iFile</a> * </td><td valign=bottom><a class="el" href="classnFANTOM100_1_1iFileIterator.html#a0">getFile</a> (<a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> &status)=0</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Creates a file object for the file referenced by this iterator.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classnFANTOM100_1_1iFileIterator.html#a1">advance</a> (<a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> &status)=0</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Advances this iterator.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classnFANTOM100_1_1iFileIterator.html#a2">getName</a> (ViChar fileName[], <a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> &status)=0</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Retrieves the name of the file to which this iterator refers.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>virtual ViUInt32 </td><td valign=bottom><a class="el" href="classnFANTOM100_1_1iFileIterator.html#a3">getSize</a> (<a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> &status)=0</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Retrieves the total size, in bytes, of the file to which this iterator refers.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="b0" doxytag="nFANTOM100::iFileIterator::~iFileIterator"></a>
|
|
virtual </td><td valign=bottom><a class="el" href="classnFANTOM100_1_1iFileIterator.html#b0">~iFileIterator</a> ()=0</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Destructor.</em></font><br><br></td></tr>
|
|
<tr><td colspan=2><br><h2>Friends</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="l0" doxytag="nFANTOM100::iFileIterator::tNXT"></a>
|
|
class </td><td valign=bottom><b>tNXT</b></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
Interface to an iterator for files on a LEGO MINDSTORMS NXT.
|
|
<p>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a name="a1" doxytag="nFANTOM100::iFileIterator::advance"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> virtual void nFANTOM100::iFileIterator::advance </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> & </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>status</em> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap><code> [pure virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Advances this iterator.
|
|
<p>
|
|
Advances this iterator to the next file that matches the previously specified file name pattern. If no more files match, this iterator is advanced to the end of the list. The iterator is not advanced if the specified status is fatal. If this iterator is already at the end of the list, a fatal status will be generated.<dl compact><dt><b>
|
|
Parameters: </b><dd>
|
|
<table border=0 cellspacing=2 cellpadding=0>
|
|
<tr><td valign=top><em>status</em> </td><td>
|
|
Status chaining object. </td></tr>
|
|
</table>
|
|
</dl> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a0" doxytag="nFANTOM100::iFileIterator::getFile"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> virtual <a class="el" href="classnFANTOM100_1_1iFile.html">iFile</a>* nFANTOM100::iFileIterator::getFile </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> & </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>status</em> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap><code> [pure virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Creates a file object for the file referenced by this iterator.
|
|
<p>
|
|
Creates file object for the file referenced by this iterator. An object is not created if the specified status is fatal or if this iterator refers to the end of the list. The returned file object should be destroyed using the <a class="el" href="classnFANTOM100_1_1iNXT.html#a1">iNXT::destroyFile</a> method.<dl compact><dt><b>
|
|
Parameters: </b><dd>
|
|
<table border=0 cellspacing=2 cellpadding=0>
|
|
<tr><td valign=top><em>status</em> </td><td>
|
|
Status chaining object. </td></tr>
|
|
</table>
|
|
</dl><dl compact><dt><b>
|
|
Returns: </b><dd>
|
|
A pointer to the <a class="el" href="classnFANTOM100_1_1iFile.html">iFile</a> object that was created. </dl> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a2" doxytag="nFANTOM100::iFileIterator::getName"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> virtual void nFANTOM100::iFileIterator::getName </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">ViChar </td>
|
|
<td class="mdname" nowrap> <em>fileName</em>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap><a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> & </td>
|
|
<td class="mdname" nowrap> <em>status</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Retrieves the name of the file to which this iterator refers.
|
|
<p>
|
|
<dl compact><dt><b>
|
|
Parameters: </b><dd>
|
|
<table border=0 cellspacing=2 cellpadding=0>
|
|
<tr><td valign=top><em>fileName</em> </td><td>
|
|
Populated with the name of the file to which this iterator refers. The file name character array must be able to accomodate a NULL-terminated, 15.3 formatted file name. This is, it must have a capacity of 20 bytes. </td></tr>
|
|
<tr><td valign=top><em>status</em> </td><td>
|
|
Status chaining object. </td></tr>
|
|
</table>
|
|
</dl> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a3" doxytag="nFANTOM100::iFileIterator::getSize"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> virtual ViUInt32 nFANTOM100::iFileIterator::getSize </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> & </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>status</em> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap><code> [pure virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Retrieves the total size, in bytes, of the file to which this iterator refers.
|
|
<p>
|
|
<dl compact><dt><b>
|
|
Parameters: </b><dd>
|
|
<table border=0 cellspacing=2 cellpadding=0>
|
|
<tr><td valign=top><em>status</em> </td><td>
|
|
Status chaining object. </td></tr>
|
|
</table>
|
|
</dl><dl compact><dt><b>
|
|
Returns: </b><dd>
|
|
The total size of the file in bytes. </dl> </td>
|
|
</tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="iFileIterator_8h-source.html">iFileIterator.h</a></ul>
|
|
<p>
|
|
© Copyright 2005-2006, National Instruments Corporation. All rights reserved.
|
|
</p>
|
|
</body></html>
|
|
|