<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>GNU Radio 3.6.4.1 C++ API: file_meta_sink.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU Radio 3.6.4.1 C++ API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('file__meta__sink_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">file_meta_sink.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="file__meta__sink_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* -*- c++ -*- */</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2012 Free Software Foundation, Inc.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This file is part of GNU Radio</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * it under the terms of the GNU General Public License as published by</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * any later version.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * GNU General Public License for more details.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * You should have received a copy of the GNU General Public License</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * Boston, MA 02110-1301, USA.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef INCLUDED_BLOCKS_FILE_META_SINK_H</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_BLOCKS_FILE_META_SINK_H</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="gr-blocks_2include_2blocks_2api_8h.html">blocks/api.h</a>></span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="gr__sync__block_8h.html">gr_sync_block.h</a>></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span>gr {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">namespace </span>blocks {</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="namespacegr_1_1blocks.html#aa3ab382f8014358ed9a5f35d8f79f885"> 32</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> <a class="code" href="namespacegr_1_1blocks.html#aa3ab382f8014358ed9a5f35d8f79f885">METADATA_VERSION</a> = 0;</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="code" href="namespacegr_1_1blocks.html#a9b8c10e9339bb3094d0b5fd2cf2d3f53"> 33</a></span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code" href="namespacegr_1_1blocks.html#a9b8c10e9339bb3094d0b5fd2cf2d3f53">METADATA_HEADER_SIZE</a> = 149;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="code" href="namespacegr_1_1blocks.html#aaf04a89b376fbc06cb75effeb40111b6"> 35</a></span>  <span class="keyword">enum</span> <a class="code" href="namespacegr_1_1blocks.html#aaf04a89b376fbc06cb75effeb40111b6">gr_file_types</a> {</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="code" href="namespacegr_1_1blocks.html#aaf04a89b376fbc06cb75effeb40111b6a0ccdd1487ca349aea3efde7daecaef65"> 36</a></span>  <a class="code" href="namespacegr_1_1blocks.html#aaf04a89b376fbc06cb75effeb40111b6a0ccdd1487ca349aea3efde7daecaef65">GR_FILE_BYTE</a>=0,</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="code" href="namespacegr_1_1blocks.html#aaf04a89b376fbc06cb75effeb40111b6a9398c5264fb25d5aa2a9d08f1e68ad79"> 37</a></span>  <a class="code" href="namespacegr_1_1blocks.html#aaf04a89b376fbc06cb75effeb40111b6a9398c5264fb25d5aa2a9d08f1e68ad79">GR_FILE_CHAR</a>=0,</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="code" href="namespacegr_1_1blocks.html#aaf04a89b376fbc06cb75effeb40111b6af08508c6dd7fc2dfb9529a9d82d6164f"> 38</a></span>  <a class="code" href="namespacegr_1_1blocks.html#aaf04a89b376fbc06cb75effeb40111b6af08508c6dd7fc2dfb9529a9d82d6164f">GR_FILE_SHORT</a>=1,</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="code" href="namespacegr_1_1blocks.html#aaf04a89b376fbc06cb75effeb40111b6ad98b7975f581d3864006ca663aee722d"> 39</a></span>  <a class="code" href="namespacegr_1_1blocks.html#aaf04a89b376fbc06cb75effeb40111b6ad98b7975f581d3864006ca663aee722d">GR_FILE_INT</a>,</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="code" href="namespacegr_1_1blocks.html#aaf04a89b376fbc06cb75effeb40111b6a07ad82268bf96f539676f8545be40ec8"> 40</a></span>  <a class="code" href="namespacegr_1_1blocks.html#aaf04a89b376fbc06cb75effeb40111b6a07ad82268bf96f539676f8545be40ec8">GR_FILE_LONG</a>,</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="code" href="namespacegr_1_1blocks.html#aaf04a89b376fbc06cb75effeb40111b6aeba7eac37ba5a0ab76cf12efae97e39a"> 41</a></span>  <a class="code" href="namespacegr_1_1blocks.html#aaf04a89b376fbc06cb75effeb40111b6aeba7eac37ba5a0ab76cf12efae97e39a">GR_FILE_LONG_LONG</a>,</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="code" href="namespacegr_1_1blocks.html#aaf04a89b376fbc06cb75effeb40111b6acc39a9c09fab2b114ddb5ac6ec3a63f9"> 42</a></span>  <a class="code" href="namespacegr_1_1blocks.html#aaf04a89b376fbc06cb75effeb40111b6acc39a9c09fab2b114ddb5ac6ec3a63f9">GR_FILE_FLOAT</a>,</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="code" href="namespacegr_1_1blocks.html#aaf04a89b376fbc06cb75effeb40111b6a59bbff58dc3f23afa79642d7c9e09a14"> 43</a></span>  <a class="code" href="namespacegr_1_1blocks.html#aaf04a89b376fbc06cb75effeb40111b6a59bbff58dc3f23afa79642d7c9e09a14">GR_FILE_DOUBLE</a>,</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  };</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> /*!</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * \brief Write stream to file with meta-data headers.</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * \ingroup sink_blk</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * These files represent data as binary information in between</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * meta-data headers. The headers contain information about the</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * type of data and properties of the data in the next segment of</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * samples. The information includes:</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * rx_rate (double): sample rate of data.</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * rx_time (uint64_t, double): time stamp of first sample in segment.</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * size (uint32_t): item size in bytes.</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * type (gr_file_types as int32_t): data type.</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * cplx (bool): Is data complex?</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * strt (uint64_t): Starting byte of data in this segment.</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * bytes (uint64_t): Size in bytes of data in this segment.</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * Tags can be sent to the file to update the information, which</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * will create a new header. Headers are found by searching from</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * the first header (at position 0 in the file) and reading where</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * the data segment starts plus the data segment size. Following</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * will either be a new header or EOF.</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="code" href="classgr_1_1blocks_1_1file__meta__sink.html"> 69</a></span>  <span class="keyword">class </span><a class="code" href="gr-blocks_2include_2blocks_2api_8h.html#a0bb81384d93233b7a728722dbf3d8e0a">BLOCKS_API</a> <a class="code" href="classgr_1_1blocks_1_1file__meta__sink.html" title="Write stream to file with meta-data headers.These files represent data as binary information in betwe...">file_meta_sink</a> : <span class="keyword">virtual</span> <span class="keyword">public</span> <a class="code" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...">gr_sync_block</a></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  {</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="comment">// gr::blocks::file_meta_sink::sptr</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"><a class="code" href="classgr_1_1blocks_1_1file__meta__sink.html#aa37b12bb43434add196d7de9bd8f9b4b"> 73</a></span>  <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<file_meta_sink></a> <a class="code" href="classgr_1_1blocks_1_1file__meta__sink.html#aa37b12bb43434add196d7de9bd8f9b4b">sptr</a>;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"></span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> /*!</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * \brief Create a meta-data file sink.</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * \param itemsize (size_t): Size of data type.</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * \param filename (string): Name of file to write data to.</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * \param samp_rate (double): Sample rate of data. If sample rate will be</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * set by a tag, such as rx_tag from a UHD source, this is</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * basically ignored.</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * \param relative_rate (double): Rate chance from source of sample</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * rate tag to sink.</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> * \param type (gr_file_types): Data type (int, float, etc.)</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * \param complex (bool): If data stream is complex</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * \param max_segment_size (size_t): Length of a single segment</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * before the header is repeated (in items).</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * \param extra_dict (string): a serialized PMT dictionary of extra</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * information. Currently not supported.</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * \param detached_header (bool): Set to true to store the header</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * info in a separate file (named filename.hdr)</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">static</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">sptr</a> make(<span class="keywordtype">size_t</span> itemsize, <span class="keyword">const</span> std::string &filename,</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">double</span> samp_rate=1, <span class="keywordtype">double</span> relative_rate=1,</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="namespacegr_1_1blocks.html#aaf04a89b376fbc06cb75effeb40111b6">gr_file_types</a> type=<a class="code" href="namespacegr_1_1blocks.html#aaf04a89b376fbc06cb75effeb40111b6acc39a9c09fab2b114ddb5ac6ec3a63f9">GR_FILE_FLOAT</a>, <span class="keywordtype">bool</span> complex=<span class="keyword">true</span>,</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">size_t</span> max_segment_size=1000000,</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">const</span> std::string &extra_dict=<span class="stringliteral">""</span>,</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordtype">bool</span> detached_header=<span class="keyword">false</span>);</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> open(<span class="keyword">const</span> std::string &filename) = 0;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> close() = 0;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> do_update() = 0;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> set_unbuffered(<span class="keywordtype">bool</span> unbuffered) = 0;</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  };</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  } <span class="comment">/* namespace blocks */</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> } <span class="comment">/* namespace gr */</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_BLOCKS_FILE_META_SINK_H */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_163b61ceea2e02982ffc042218391854.html">gr-blocks</a></li><li class="navelem"><a class="el" href="dir_9478a5f63f06b684a30452b461bb1a57.html">include</a></li><li class="navelem"><a class="el" href="dir_40e015244c471c30c47ef5361129cd6c.html">blocks</a></li><li class="navelem"><a class="el" href="file__meta__sink_8h.html">file_meta_sink.h</a></li>
<li class="footer">Generated on Fri Apr 19 2013 16:20:33 for GNU Radio 3.6.4.1 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
</ul>
</div>
</body>
</html>
