<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GNU Radio 3.3.0 C++ API: gr_file_source Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="contents">
<h1>gr_file_source Class Reference<br/>
<small>
[<a class="el" href="group__source__blk.html">Signal Sources</a>]</small>
</h1><!-- doxytag: class="gr_file_source" --><!-- doxytag: inherits="gr_sync_block" -->
<p>Read stream from file.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__file__source_8h_source.html">gr_file_source.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_file_source:</div>
<div class="dynsection">
<div class="center"><img src="classgr__file__source__inherit__graph.png" border="0" usemap="#gr__file__source_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__file__source_inherit__map" id="gr__file__source_inherit__map">
<area shape="rect" id="node2" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing..." alt="" coords="21,315,128,344"/><area shape="rect" id="node4" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing..." alt="" coords="40,237,109,267"/><area shape="rect" id="node6" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare..." alt="" coords="20,160,129,189"/><area shape="rect" id="node8" href="classgr__msg__accepter.html" title="Accepts messages and inserts them into a message queue, then notifies subclass gr_basic_block..." alt="" coords="13,83,136,112"/><area shape="rect" id="node10" href="classgruel_1_1msg__accepter.html" title="Virtual base class that accepts messages." alt="" coords="5,5,144,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__file__source-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__file__source.html#a6f48f666cf2ce07f32be02f08561ff24">~gr_file_source</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__file__source.html#a498f0bb7a704de43e3c1ffb61fed0d1d">work</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">just like <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you <a href="#a498f0bb7a704de43e3c1ffb61fed0d1d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__file__source.html#a0a206ac10dccf0e7b8faabd836a20846">seek</a> (long seek_point, int whence)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">seek file to <code>seek_point</code> relative to <code>whence</code> <a href="#a0a206ac10dccf0e7b8faabd836a20846"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__file__source.html#ad237a93ac0cdf390d52ecaf5ba47a01a">gr_file_source</a> (size_t itemsize, const char *filename, <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> repeat)</td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_file_source_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__file__source.html#a10a67e888b7e5056528929944853f971">gr_make_file_source</a> (size_t itemsize, const char *filename, <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> repeat)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Read stream from file. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad237a93ac0cdf390d52ecaf5ba47a01a"></a><!-- doxytag: member="gr_file_source::gr_file_source" ref="ad237a93ac0cdf390d52ecaf5ba47a01a" args="(size_t itemsize, const char *filename, bool repeat)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_file_source::gr_file_source </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>itemsize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td>
<td class="paramname"> <em>repeat</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a6f48f666cf2ce07f32be02f08561ff24"></a><!-- doxytag: member="gr_file_source::~gr_file_source" ref="a6f48f666cf2ce07f32be02f08561ff24" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_file_source::~gr_file_source </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0a206ac10dccf0e7b8faabd836a20846"></a><!-- doxytag: member="gr_file_source::seek" ref="a0a206ac10dccf0e7b8faabd836a20846" args="(long seek_point, int whence)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> gr_file_source::seek </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"> <em>seek_point</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>whence</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>seek file to <code>seek_point</code> relative to <code>whence</code> </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>seek_point</em> </td><td>sample offset in file </td></tr>
<tr><td valign="top"></td><td valign="top"><em>whence</em> </td><td>one of SEEK_SET, SEEK_CUR, SEEK_END (man fseek) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a498f0bb7a704de43e3c1ffb61fed0d1d"></a><!-- doxytag: member="gr_file_source::work" ref="a498f0bb7a704de43e3c1ffb61fed0d1d" args="(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_file_source::work </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>noutput_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> & </td>
<td class="paramname"> <em>input_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> & </td>
<td class="paramname"> <em>output_items</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>just like <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you </p>
<p>The user must override work to define the signal processing code </p>
<p>Implements <a class="el" href="classgr__sync__block.html#a0c523f4285a6eb690f677ee6295ab117">gr_sync_block</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a10a67e888b7e5056528929944853f971"></a><!-- doxytag: member="gr_file_source::gr_make_file_source" ref="a10a67e888b7e5056528929944853f971" args="(size_t itemsize, const char *filename, bool repeat)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_file_source_sptr</a> gr_make_file_source </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>itemsize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td>
<td class="paramname"> <em>repeat</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gr__file__source_8h_source.html">gr_file_source.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:52:42 2010 for GNU Radio 3.3.0 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
