<!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.2.2 C++ API: gr_file_sink_base 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.2 -->
<div class="contents">
<h1>gr_file_sink_base Class Reference</h1><!-- doxytag: class="gr_file_sink_base" -->
<p>Common base class for file sinks.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__file__sink__base_8h_source.html">gr_file_sink_base.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_file_sink_base:</div>
<div class="dynsection">
<div class="center"><img src="classgr__file__sink__base__inherit__graph.png" border="0" usemap="#gr__file__sink__base_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__file__sink__base_inherit__map" id="gr__file__sink__base_inherit__map">
<area shape="rect" id="node3" href="classgr__file__sink.html" title="Write stream to file." alt="" coords="23,83,111,112"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__file__sink__base-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__sink__base.html#a37b3f2432e56dfd8ff8d70d2e08a657b">~gr_file_sink_base</a> ()</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__sink__base.html#a10aaf2ad9ef353fc1c59551d3470f64b">open</a> (const char *filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open filename and begin output to it. <a href="#a10aaf2ad9ef353fc1c59551d3470f64b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__file__sink__base.html#a15fee46d8070d8cd1786bcdf3901b5df">close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close current output file. <a href="#a15fee46d8070d8cd1786bcdf3901b5df"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__file__sink__base.html#a2c500bf0f2106cfadeb54976410416d9">do_update</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">if we've had an update, do it now. <a href="#a2c500bf0f2106cfadeb54976410416d9"></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__sink__base.html#a94d0aa96bdcdf647bd1f1dc7d4882839">gr_file_sink_base</a> (const char *filename, <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> is_binary)</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FILE * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__file__sink__base.html#ab456fb9924239a56cafdfd4e3d3b5ee1">d_fp</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FILE * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__file__sink__base.html#a7d716a5627d11d8e68341ab3d3855b07">d_new_fp</a></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__sink__base.html#a3322e5059ccae5f8c5d2ce0edc0df91a">d_updated</a></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__sink__base.html#ada5f41c561d503d233b64ba76e61a738">d_is_binary</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classomni__mutex.html">omni_mutex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__file__sink__base.html#aadadfbb7eb4f8374a371f505fd207415">d_mutex</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Common base class for file sinks. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a94d0aa96bdcdf647bd1f1dc7d4882839"></a><!-- doxytag: member="gr_file_sink_base::gr_file_sink_base" ref="a94d0aa96bdcdf647bd1f1dc7d4882839" args="(const char *filename, bool is_binary)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_file_sink_base::gr_file_sink_base </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>is_binary</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="a37b3f2432e56dfd8ff8d70d2e08a657b"></a><!-- doxytag: member="gr_file_sink_base::~gr_file_sink_base" ref="a37b3f2432e56dfd8ff8d70d2e08a657b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_file_sink_base::~gr_file_sink_base </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="a15fee46d8070d8cd1786bcdf3901b5df"></a><!-- doxytag: member="gr_file_sink_base::close" ref="a15fee46d8070d8cd1786bcdf3901b5df" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_file_sink_base::close </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close current output file. </p>
<p>Closes current output file and ignores any output until open is called to connect to another file. </p>
</div>
</div>
<a class="anchor" id="a2c500bf0f2106cfadeb54976410416d9"></a><!-- doxytag: member="gr_file_sink_base::do_update" ref="a2c500bf0f2106cfadeb54976410416d9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_file_sink_base::do_update </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>if we've had an update, do it now. </p>
</div>
</div>
<a class="anchor" id="a10aaf2ad9ef353fc1c59551d3470f64b"></a><!-- doxytag: member="gr_file_sink_base::open" ref="a10aaf2ad9ef353fc1c59551d3470f64b" args="(const char *filename)" -->
<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_sink_base::open </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>filename</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Open filename and begin output to it. </p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ab456fb9924239a56cafdfd4e3d3b5ee1"></a><!-- doxytag: member="gr_file_sink_base::d_fp" ref="ab456fb9924239a56cafdfd4e3d3b5ee1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FILE* <a class="el" href="classgr__file__sink__base.html#ab456fb9924239a56cafdfd4e3d3b5ee1">gr_file_sink_base::d_fp</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ada5f41c561d503d233b64ba76e61a738"></a><!-- doxytag: member="gr_file_sink_base::d_is_binary" ref="ada5f41c561d503d233b64ba76e61a738" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> <a class="el" href="classgr__file__sink__base.html#ada5f41c561d503d233b64ba76e61a738">gr_file_sink_base::d_is_binary</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aadadfbb7eb4f8374a371f505fd207415"></a><!-- doxytag: member="gr_file_sink_base::d_mutex" ref="aadadfbb7eb4f8374a371f505fd207415" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classomni__mutex.html">omni_mutex</a> <a class="el" href="classgr__file__sink__base.html#aadadfbb7eb4f8374a371f505fd207415">gr_file_sink_base::d_mutex</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a7d716a5627d11d8e68341ab3d3855b07"></a><!-- doxytag: member="gr_file_sink_base::d_new_fp" ref="a7d716a5627d11d8e68341ab3d3855b07" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FILE* <a class="el" href="classgr__file__sink__base.html#a7d716a5627d11d8e68341ab3d3855b07">gr_file_sink_base::d_new_fp</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a3322e5059ccae5f8c5d2ce0edc0df91a"></a><!-- doxytag: member="gr_file_sink_base::d_updated" ref="a3322e5059ccae5f8c5d2ce0edc0df91a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> <a class="el" href="classgr__file__sink__base.html#a3322e5059ccae5f8c5d2ce0edc0df91a">gr_file_sink_base::d_updated</a><code> [protected]</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__sink__base_8h_source.html">gr_file_sink_base.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>
