<!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_packed_to_unpacked_ss 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_packed_to_unpacked_ss Class Reference<br/>
<small>
[<a class="el" href="group__converter__blk.html">Type Conversions</a>]</small>
</h1><!-- doxytag: class="gr_packed_to_unpacked_ss" --><!-- doxytag: inherits="gr_block" -->
<p>Convert a stream of packed bytes or shorts to stream of unpacked bytes or shorts.input: stream of short; output: stream of short.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__packed__to__unpacked__ss_8h_source.html">gr_packed_to_unpacked_ss.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_packed_to_unpacked_ss:</div>
<div class="dynsection">
<div class="center"><img src="classgr__packed__to__unpacked__ss__inherit__graph.png" border="0" usemap="#gr__packed__to__unpacked__ss_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__packed__to__unpacked__ss_inherit__map" id="gr__packed__to__unpacked__ss_inherit__map">
<area shape="rect" id="node2" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing..." alt="" coords="63,237,132,267"/><area shape="rect" id="node4" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare..." alt="" coords="43,160,152,189"/><area shape="rect" id="node6" href="classgr__msg__accepter.html" title="Accepts messages and inserts them into a message queue, then notifies subclass gr_basic_block..." alt="" coords="36,83,159,112"/><area shape="rect" id="node8" href="classgruel_1_1msg__accepter.html" title="Virtual base class that accepts messages." alt="" coords="28,5,167,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__packed__to__unpacked__ss-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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__packed__to__unpacked__ss.html#adfa131f8fab79ded3d50ceaa4ad09274">forecast</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_int</a> &ninput_items_required)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Estimate input requirements given output request. <a href="#adfa131f8fab79ded3d50ceaa4ad09274"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__packed__to__unpacked__ss.html#a91269652815c6ba7df04fc14cf74046c">general_work</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_int</a> &ninput_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">compute output items from input items <a href="#a91269652815c6ba7df04fc14cf74046c"></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__packed__to__unpacked__ss.html#ab820f35beda6a186338d07e740ccf2f9">check_topology</a> (int ninputs, int noutputs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Confirm that ninputs and noutputs is an acceptable combination. <a href="#ab820f35beda6a186338d07e740ccf2f9"></a><br/></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_packed_to_unpacked_ss_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__packed__to__unpacked__ss.html#a1a70af23862071ef47ee1ab55eb9261a">gr_make_packed_to_unpacked_ss</a> (unsigned int bits_per_chunk, <a class="el" href="gr__endianness_8h.html#aa340baf760c129189bc842d8f2c0e2e6">gr_endianness_t</a> endianness)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Convert a stream of packed bytes or shorts to stream of unpacked bytes or shorts.</p>
<p>input: stream of short; output: stream of short. </p>
<p>This is the inverse of gr_unpacked_to_packed_XX.</p>
<p>The bits in the bytes or shorts input stream are grouped into chunks of <code>bits_per_chunk</code> bits and each resulting chunk is written right- justified to the output stream of bytes or shorts. All b or 16 bits of the each input bytes or short are processed. The right thing is done if bits_per_chunk is not a power of two.</p>
<p>The combination of gr_packed_to_unpacked_XX_ followed by gr_chunks_to_symbols_Xf or gr_chunks_to_symbols_Xc handles the general case of mapping from a stream of bytes or shorts into arbitrary float or complex symbols.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classgr__packed__to__unpacked__bb.html" title="Convert a stream of packed bytes or shorts to stream of unpacked bytes or shorts...">gr_packed_to_unpacked_bb</a>, <a class="el" href="classgr__unpacked__to__packed__bb.html" title="Convert a stream of unpacked bytes or shorts into a stream of packed bytes or shorts...">gr_unpacked_to_packed_bb</a>, </dd>
<dd>
<a class="el" href="classgr__packed__to__unpacked__ss.html" title="Convert a stream of packed bytes or shorts to stream of unpacked bytes or shorts...">gr_packed_to_unpacked_ss</a>, <a class="el" href="classgr__unpacked__to__packed__ss.html" title="Convert a stream of unpacked bytes or shorts into a stream of packed bytes or shorts...">gr_unpacked_to_packed_ss</a>, </dd>
<dd>
<a class="el" href="classgr__chunks__to__symbols__bf.html" title="Map a stream of symbol indexes (unpacked bytes or shorts) to stream of float or complex...">gr_chunks_to_symbols_bf</a>, <a class="el" href="classgr__chunks__to__symbols__bc.html" title="Map a stream of symbol indexes (unpacked bytes or shorts) to stream of float or complex...">gr_chunks_to_symbols_bc</a>. </dd>
<dd>
<a class="el" href="classgr__chunks__to__symbols__sf.html" title="Map a stream of symbol indexes (unpacked bytes or shorts) to stream of float or complex...">gr_chunks_to_symbols_sf</a>, <a class="el" href="classgr__chunks__to__symbols__sc.html" title="Map a stream of symbol indexes (unpacked bytes or shorts) to stream of float or complex...">gr_chunks_to_symbols_sc</a>. </dd></dl>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab820f35beda6a186338d07e740ccf2f9"></a><!-- doxytag: member="gr_packed_to_unpacked_ss::check_topology" ref="ab820f35beda6a186338d07e740ccf2f9" args="(int ninputs, int noutputs)" -->
<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_packed_to_unpacked_ss::check_topology </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>ninputs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>noutputs</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Confirm that ninputs and noutputs is an acceptable combination. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ninputs</em> </td><td>number of input streams connected </td></tr>
<tr><td valign="top"></td><td valign="top"><em>noutputs</em> </td><td>number of output streams connected</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if this is a valid configuration for this block.</dd></dl>
<p>This function is called by the runtime system whenever the topology changes. Most classes do not need to override this. This check is in addition to the constraints specified by the input and output gr_io_signatures. </p>
<p>Reimplemented from <a class="el" href="classgr__basic__block.html#a50a714df9c3ce8c03854a09ac84e589b">gr_basic_block</a>.</p>
</div>
</div>
<a class="anchor" id="adfa131f8fab79ded3d50ceaa4ad09274"></a><!-- doxytag: member="gr_packed_to_unpacked_ss::forecast" ref="adfa131f8fab79ded3d50ceaa4ad09274" args="(int noutput_items, gr_vector_int &ninput_items_required)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_packed_to_unpacked_ss::forecast </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_int</a> & </td>
<td class="paramname"> <em>ninput_items_required</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>Estimate input requirements given output request. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>noutput_items</em> </td><td>number of output items to produce </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ninput_items_required</em> </td><td>number of input items required on each input stream</td></tr>
</table>
</dd>
</dl>
<p>Given a request to product <code>noutput_items</code>, estimate the number of data items required on each input stream. The estimate doesn't have to be exact, but should be close. </p>
<p>Reimplemented from <a class="el" href="classgr__block.html#aa1f2518b5c97126bb015adb9e2027f4a">gr_block</a>.</p>
</div>
</div>
<a class="anchor" id="a91269652815c6ba7df04fc14cf74046c"></a><!-- doxytag: member="gr_packed_to_unpacked_ss::general_work" ref="a91269652815c6ba7df04fc14cf74046c" args="(int noutput_items, gr_vector_int &ninput_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_packed_to_unpacked_ss::general_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_int</a> & </td>
<td class="paramname"> <em>ninput_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>compute output items from input items </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>noutput_items</em> </td><td>number of output items to write on each output stream </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ninput_items</em> </td><td>number of input items available on each input stream </td></tr>
<tr><td valign="top"></td><td valign="top"><em>input_items</em> </td><td>vector of pointers to the input items, one entry per input stream </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output_items</em> </td><td>vector of pointers to the output items, one entry per output stream</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of items actually written to each output stream, or -1 on EOF. It is OK to return a value less than noutput_items. -1 <= return value <= noutput_items</dd></dl>
<p>general_work must call consume or consume_each to indicate how many items were consumed on each input stream. </p>
<p>Implements <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197">gr_block</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a1a70af23862071ef47ee1ab55eb9261a"></a><!-- doxytag: member="gr_packed_to_unpacked_ss::gr_make_packed_to_unpacked_ss" ref="a1a70af23862071ef47ee1ab55eb9261a" args="(unsigned int bits_per_chunk, gr_endianness_t endianness)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_packed_to_unpacked_ss_sptr</a> gr_make_packed_to_unpacked_ss </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>bits_per_chunk</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="gr__endianness_8h.html#aa340baf760c129189bc842d8f2c0e2e6">gr_endianness_t</a> </td>
<td class="paramname"> <em>endianness</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__packed__to__unpacked__ss_8h_source.html">gr_packed_to_unpacked_ss.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:52:52 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>
