<!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_io_signature.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.3 --> <div id="top"> <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.2.2 C++ API</div> </td> </tr> </tbody> </table> </div> </div> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('gr__io__signature_8h.html',''); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <h1>gr_io_signature.h</h1> </div> </div> <div class="contents"> <a href="gr__io__signature_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span> <a name="l00002"></a>00002 <span class="comment">/*</span> <a name="l00003"></a>00003 <span class="comment"> * Copyright 2004,2007 Free Software Foundation, Inc.</span> <a name="l00004"></a>00004 <span class="comment"> * </span> <a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span> <a name="l00006"></a>00006 <span class="comment"> * </span> <a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span> <a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span> <a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span> <a name="l00010"></a>00010 <span class="comment"> * any later version.</span> <a name="l00011"></a>00011 <span class="comment"> * </span> <a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span> <a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span> <a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span> <a name="l00016"></a>00016 <span class="comment"> * </span> <a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span> <a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span> <a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span> <a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span> <a name="l00021"></a>00021 <span class="comment"> */</span> <a name="l00022"></a>00022 <a name="l00023"></a>00023 <span class="preprocessor">#ifndef INCLUDED_IO_SIGNATURE_H</span> <a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_IO_SIGNATURE_H</span> <a name="l00025"></a>00025 <span class="preprocessor"></span> <a name="l00026"></a>00026 <span class="preprocessor">#include <<a class="code" href="gr__runtime__types_8h.html">gr_runtime_types.h</a>></span> <a name="l00027"></a>00027 <span class="comment"></span> <a name="l00028"></a>00028 <span class="comment">/*!</span> <a name="l00029"></a>00029 <span class="comment"> * \brief Create an i/o signature</span> <a name="l00030"></a>00030 <span class="comment"> *</span> <a name="l00031"></a>00031 <span class="comment"> * \ingroup internal</span> <a name="l00032"></a>00032 <span class="comment"> * \param min_streams specify minimum number of streams (>= 0)</span> <a name="l00033"></a>00033 <span class="comment"> * \param max_streams specify maximum number of streams (>= min_streams or -1 -> infinite)</span> <a name="l00034"></a>00034 <span class="comment"> * \param sizeof_stream_item specify the size of the items in each stream</span> <a name="l00035"></a>00035 <span class="comment"> */</span> <a name="l00036"></a>00036 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_io_signature_sptr</a> <a name="l00037"></a>00037 <a class="code" href="group__internal.html#ga1fbae03d2f3546a3768cab55cc5f986c" title="Create an i/o signature.">gr_make_io_signature</a>(<span class="keywordtype">int</span> min_streams, <span class="keywordtype">int</span> max_streams, <a name="l00038"></a>00038 <span class="keywordtype">int</span> sizeof_stream_item); <a name="l00039"></a>00039 <span class="comment"></span> <a name="l00040"></a>00040 <span class="comment">/*!</span> <a name="l00041"></a>00041 <span class="comment"> * \brief Create an i/o signature</span> <a name="l00042"></a>00042 <span class="comment"> *</span> <a name="l00043"></a>00043 <span class="comment"> * \param min_streams specify minimum number of streams (>= 0)</span> <a name="l00044"></a>00044 <span class="comment"> * \param max_streams specify maximum number of streams (>= min_streams or -1 -> infinite)</span> <a name="l00045"></a>00045 <span class="comment"> * \param sizeof_stream_item1 specify the size of the items in the first stream</span> <a name="l00046"></a>00046 <span class="comment"> * \param sizeof_stream_item2 specify the size of the items in the second and subsequent streams</span> <a name="l00047"></a>00047 <span class="comment"> */</span> <a name="l00048"></a>00048 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_io_signature_sptr</a> <a name="l00049"></a>00049 <a class="code" href="gr__io__signature_8h.html#a878d8f330140c11f2ccf9d42570d9df0" title="Create an i/o signature.">gr_make_io_signature2</a>(<span class="keywordtype">int</span> min_streams, <span class="keywordtype">int</span> max_streams, <a name="l00050"></a>00050 <span class="keywordtype">int</span> sizeof_stream_item1, <a name="l00051"></a>00051 <span class="keywordtype">int</span> sizeof_stream_item2 <a name="l00052"></a>00052 ); <a name="l00053"></a>00053 <span class="comment"></span> <a name="l00054"></a>00054 <span class="comment">/*!</span> <a name="l00055"></a>00055 <span class="comment"> * \brief Create an i/o signature</span> <a name="l00056"></a>00056 <span class="comment"> *</span> <a name="l00057"></a>00057 <span class="comment"> * \param min_streams specify minimum number of streams (>= 0)</span> <a name="l00058"></a>00058 <span class="comment"> * \param max_streams specify maximum number of streams (>= min_streams or -1 -> infinite)</span> <a name="l00059"></a>00059 <span class="comment"> * \param sizeof_stream_item1 specify the size of the items in the first stream</span> <a name="l00060"></a>00060 <span class="comment"> * \param sizeof_stream_item2 specify the size of the items in the second stream</span> <a name="l00061"></a>00061 <span class="comment"> * \param sizeof_stream_item3 specify the size of the items in the third and subsequent streams</span> <a name="l00062"></a>00062 <span class="comment"> */</span> <a name="l00063"></a>00063 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_io_signature_sptr</a> <a name="l00064"></a>00064 <a class="code" href="gr__io__signature_8h.html#a11e62b8132ae19fd5e3172065f73d490" title="Create an i/o signature.">gr_make_io_signature3</a>(<span class="keywordtype">int</span> min_streams, <span class="keywordtype">int</span> max_streams, <a name="l00065"></a>00065 <span class="keywordtype">int</span> sizeof_stream_item1, <a name="l00066"></a>00066 <span class="keywordtype">int</span> sizeof_stream_item2, <a name="l00067"></a>00067 <span class="keywordtype">int</span> sizeof_stream_item3 <a name="l00068"></a>00068 ); <a name="l00069"></a>00069 <span class="comment"></span> <a name="l00070"></a>00070 <span class="comment">/*!</span> <a name="l00071"></a>00071 <span class="comment"> * \brief Create an i/o signature</span> <a name="l00072"></a>00072 <span class="comment"> *</span> <a name="l00073"></a>00073 <span class="comment"> * \param min_streams specify minimum number of streams (>= 0)</span> <a name="l00074"></a>00074 <span class="comment"> * \param max_streams specify maximum number of streams (>= min_streams or -1 -> infinite)</span> <a name="l00075"></a>00075 <span class="comment"> * \param sizeof_stream_items specify the size of the items in the streams</span> <a name="l00076"></a>00076 <span class="comment"> *</span> <a name="l00077"></a>00077 <span class="comment"> * If there are more streams than there are entries in sizeof_stream_items, the</span> <a name="l00078"></a>00078 <span class="comment"> * value of the last entry in sizeof_stream_items is used for the missing values.</span> <a name="l00079"></a>00079 <span class="comment"> * sizeof_stream_items must contain at least 1 entry.</span> <a name="l00080"></a>00080 <span class="comment"> */</span> <a name="l00081"></a>00081 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_io_signature_sptr</a> <a name="l00082"></a>00082 <a class="code" href="gr__io__signature_8h.html#a80eeff275639913a51cc4d8b07859a92" title="Create an i/o signature.">gr_make_io_signaturev</a>(<span class="keywordtype">int</span> min_streams, <span class="keywordtype">int</span> max_streams, <a name="l00083"></a>00083 <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<int></a> &sizeof_stream_items); <a name="l00084"></a>00084 <a name="l00085"></a>00085 <span class="comment"></span> <a name="l00086"></a>00086 <span class="comment">/*!</span> <a name="l00087"></a>00087 <span class="comment"> * \brief i/o signature for input and output ports.</span> <a name="l00088"></a>00088 <span class="comment"> * \brief misc</span> <a name="l00089"></a>00089 <span class="comment"> */</span> <a name="l00090"></a><a class="code" href="classgr__io__signature.html">00090</a> <span class="keyword">class </span><a class="code" href="classgr__io__signature.html" title="i/o signature for input and output ports.">gr_io_signature</a> { <a name="l00091"></a>00091 <span class="keywordtype">int</span> d_min_streams; <a name="l00092"></a>00092 <span class="keywordtype">int</span> d_max_streams; <a name="l00093"></a>00093 <a class="code" href="classstd_1_1vector.html">std::vector<int></a> d_sizeof_stream_item; <a name="l00094"></a>00094 <a name="l00095"></a>00095 <a class="code" href="classgr__io__signature.html" title="i/o signature for input and output ports.">gr_io_signature</a>(<span class="keywordtype">int</span> <a class="code" href="classgr__io__signature.html#aa8d00e9ef1c575fb82f23ad91b7eeed5">min_streams</a>, <span class="keywordtype">int</span> <a class="code" href="classgr__io__signature.html#ad3b8ee26c7fb72eecf84b932f775dfd2">max_streams</a>, <a name="l00096"></a>00096 <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<int></a> &<a class="code" href="classgr__io__signature.html#abc83a822adb84f8ea2cccce70a7c3ba4">sizeof_stream_items</a>); <a name="l00097"></a>00097 <a name="l00098"></a>00098 <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> <a name="l00099"></a>00099 <a class="code" href="classgr__io__signature.html#a80eeff275639913a51cc4d8b07859a92" title="Create an i/o signature.">gr_make_io_signaturev</a>(<span class="keywordtype">int</span> min_streams, <a name="l00100"></a>00100 <span class="keywordtype">int</span> max_streams, <a name="l00101"></a>00101 <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<int></a> &sizeof_stream_items); <a name="l00102"></a>00102 <a name="l00103"></a>00103 <span class="keyword">public</span>: <a name="l00104"></a>00104 <a name="l00105"></a><a class="code" href="classgr__io__signature.html#a8d29b9fc7bfec08832c5852afdecb1a9">00105</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classgr__io__signature.html#a8d29b9fc7bfec08832c5852afdecb1a9">IO_INFINITE</a> = -1; <a name="l00106"></a>00106 <a name="l00107"></a>00107 <a class="code" href="classgr__io__signature.html#a12776009a6a97dfd40d9227505a60de4">~gr_io_signature</a> (); <a name="l00108"></a>00108 <a name="l00109"></a><a class="code" href="classgr__io__signature.html#aa8d00e9ef1c575fb82f23ad91b7eeed5">00109</a> <span class="keywordtype">int</span> <a class="code" href="classgr__io__signature.html#aa8d00e9ef1c575fb82f23ad91b7eeed5">min_streams</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_min_streams; } <a name="l00110"></a><a class="code" href="classgr__io__signature.html#ad3b8ee26c7fb72eecf84b932f775dfd2">00110</a> <span class="keywordtype">int</span> <a class="code" href="classgr__io__signature.html#ad3b8ee26c7fb72eecf84b932f775dfd2">max_streams</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_max_streams; } <a name="l00111"></a>00111 <span class="keywordtype">int</span> <a class="code" href="classgr__io__signature.html#ab834e2514693dbf9780265af15295efe">sizeof_stream_item</a> (<span class="keywordtype">int</span> index) <span class="keyword">const</span>; <a name="l00112"></a>00112 <a class="code" href="classstd_1_1vector.html">std::vector<int></a> <a class="code" href="classgr__io__signature.html#abc83a822adb84f8ea2cccce70a7c3ba4">sizeof_stream_items</a>() <span class="keyword">const</span>; <a name="l00113"></a>00113 }; <a name="l00114"></a>00114 <a name="l00115"></a>00115 <a name="l00116"></a>00116 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_IO_SIGNATURE_H */</span> </pre></div></div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="gr__io__signature_8h.html">gr_io_signature.h</a> </li> <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li> </ul> </div> </body> </html>