<html> <head><title>ClanLib Reference: CL_InputSource_File</title></head> <body text=black link=blue vlink=#800080 bgcolor=white topmargin=0 leftmargin=0> <table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td><img border=0 src="../images/eyeheader-main-purple-a.gif" alt="ClanSoft logo" width=525 height=96></td></tr> <tr bgcolor=#dadada><td align=left valign=top><img border=0 src="../images/eyeheader-main-purple-b.gif" alt="ClanSoft logo" width=190 height=14></td><td align=right valign=top><img border=0 src="../images/clanlib_light.gif" width=42 height=14></td></tr></table> <table align=center border=0 cellspacing=10> <tr> <td><a href="entire_class_index.html">Entire Class Index</a></td> <td><a href="class_index.html">Main Class Index</a></td> <td><a href="cross_index.html">Cross Index</a></td> <td><a href="global_index.html">Global Index</a></td> </table><h1 align=center>Class CL_InputSource_File</h1><p> <b> Inputsource reading from file.</b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <a href="CL_InputSource.html">CL_InputSource</a> <br> Derived by: <i>none</i> <br>Group: Core (I/O Data) <p> #include <ClanLib/core.h> <p> <hr noshade> <table border=0> <tr><td colspan=3><h3>public function member index:</h3></td> <tr valign=top><td align=left><h3>Construction:</h3></td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_InputSource_File.html#491"><tt><font color=blue><b>CL_InputSource_File</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>filename</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_InputSource_File.html#492"><tt><font color=blue><b>CL_InputSource_File</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="CL_InputSource_File.html#492"><tt><font color=blue><b>CL_InputSource_File</b></font></tt></a>* <tt><font color=blue>source</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_InputSource_File.html#493"><tt><font color=blue><b>~CL_InputSource_File</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=left><h3>Attributes:</h3></td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_InputSource_File.html#494"><tt><font color=blue><b>tell</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_InputSource_File.html#495"><tt><font color=blue><b>size</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=left><h3>Operations:</h3></td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_InputSource_File.html#496"><tt><font color=blue><b>read</b></font></tt></a></td><td><tt>(<tt><font color=purple>void</font></tt>* <tt><font color=blue>data</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>size</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_InputSource_File.html#497"><tt><font color=blue><b>open</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_InputSource_File.html#498"><tt><font color=blue><b>close</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <a href="CL_InputSource.html"><tt><font color=navy><b>CL_InputSource</b></font></tt></a>*</tt> </td><td align=right><a href="CL_InputSource_File.html#499"><tt><font color=blue><b>clone</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_InputSource_File.html#500"><tt><font color=blue><b>seek</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>pos</font></tt>, <tt><font color=navy>SeekEnum</font></tt> <tt><font color=blue>seek_type</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_InputSource_File.html#501"><tt><font color=blue><b>push_position</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_InputSource_File.html#502"><tt><font color=blue><b>pop_position</b></font></tt></a></td><td><tt>()</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> <p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="491"><font size=+1><b>CL_InputSource_File::CL_InputSource_File</b></font></a> - Input Souce File Constructor<br><tt></tt> <a href="CL_InputSource_File.html#491"><tt><font color=blue><b>CL_InputSource_File</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>filename</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="492"><font size=+1><b>CL_InputSource_File::CL_InputSource_File</b></font></a> - Input Souce File Constructor<br><tt></tt> <a href="CL_InputSource_File.html#492"><tt><font color=blue><b>CL_InputSource_File</b></font></tt></a><tt>(<tt>const</tt> <a href="CL_InputSource_File.html#492"><tt><font color=blue><b>CL_InputSource_File</b></font></tt></a>* <tt><font color=blue>source</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="499"><font size=+1><b>CL_InputSource_File::clone</b></font></a> - Make a copy of the current inputsource, standing at the same position.<br><tt><tt>virtual</tt> <a href="CL_InputSource.html"><tt><font color=navy><b>CL_InputSource</b></font></tt></a>*</tt> <a href="CL_InputSource_File.html#499"><tt><font color=blue><b>clone</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - The copy of the input source.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="498"><font size=+1><b>CL_InputSource_File::close</b></font></a> - Closes the input source.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_InputSource_File.html#498"><tt><font color=blue><b>close</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="497"><font size=+1><b>CL_InputSource_File::open</b></font></a> - Opens the input source. By default, it is open.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_InputSource_File.html#497"><tt><font color=blue><b>open</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="502"><font size=+1><b>CL_InputSource_File::pop_position</b></font></a> - Pops a previous pushed input source position (returns to the position).<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_InputSource_File.html#502"><tt><font color=blue><b>pop_position</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="501"><font size=+1><b>CL_InputSource_File::push_position</b></font></a> - Pushes the current input source position.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_InputSource_File.html#501"><tt><font color=blue><b>push_position</b></font></tt></a><tt>()</tt>;<br><blockquote> The position can be restored again with pop_position.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="496"><font size=+1><b>CL_InputSource_File::read</b></font></a> - Reads larger amounts of data (no endian and 64 bit conversion):<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_InputSource_File.html#496"><tt><font color=blue><b>read</b></font></tt></a><tt>(<tt><font color=purple>void</font></tt>* <tt><font color=blue>data</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>size</font></tt>)</tt>;<br><blockquote> data - Points to an array where the read data is stored.<br> size - Number of bytes to read.<br> Returns - Num bytes actually read.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="500"><font size=+1><b>CL_InputSource_File::seek</b></font></a> - Seeks to the specified position in the input source.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_InputSource_File.html#500"><tt><font color=blue><b>seek</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>pos</font></tt>, <tt><font color=navy>SeekEnum</font></tt> <tt><font color=blue>seek_type</font></tt>)</tt>;<br><blockquote> pos - Position relative to 'seek_type'.<br> seek_type - Defines what the 'pos' is relative to. Can be either seek_set, seek_cur og seek_end.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="495"><font size=+1><b>CL_InputSource_File::size</b></font></a> - Returns the size of the input source<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_InputSource_File.html#495"><tt><font color=blue><b>size</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - Size of the input source.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="494"><font size=+1><b>CL_InputSource_File::tell</b></font></a> - Returns current position in input source.<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_InputSource_File.html#494"><tt><font color=blue><b>tell</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - Current position in input source.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="493"><font size=+1><b>CL_InputSource_File::~CL_InputSource_File</b></font></a> - Input Souce File Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_InputSource_File.html#493"><tt><font color=blue><b>~CL_InputSource_File</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> <h2>Variable Member Descriptions:</h2> <hr noshade> </body> </html>
