<!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: comedi_sink_s 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>comedi_sink_s Class Reference</h1><!-- doxytag: class="comedi_sink_s" --><!-- doxytag: inherits="gr_sync_block" -->
<p>sink using COMEDI
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="comedi__sink__s_8h_source.html">comedi_sink_s.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for comedi_sink_s:</div>
<div class="dynsection">
<div class="center"><img src="classcomedi__sink__s__inherit__graph.png" border="0" usemap="#comedi__sink__s_inherit__map" alt="Inheritance graph"/></div>
<map name="comedi__sink__s_inherit__map" id="comedi__sink__s_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="classcomedi__sink__s-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="classcomedi__sink__s.html#ad82c337d0b3327fde04ac0db538c1a1d">~comedi_sink_s</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="classcomedi__sink__s.html#a647ad3908c6b40ef9d4a79853b226bcf">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="#a647ad3908c6b40ef9d4a79853b226bcf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcomedi__sink__s.html#a9c2a0631f26f2683ae1779ce05836303">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="#a9c2a0631f26f2683ae1779ce05836303"></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="classcomedi__sink__s.html#a1e267c1c193ef6dc2c743c66f802aaa5">comedi_sink_s</a> (int sampling_freq, const std::string device_name)</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">comedi_sink_s_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcomedi__sink__s.html#a0abddd0a4a85930752816fbed0bf98eb">comedi_make_sink_s</a> (int sampling_freq, const std::string dev)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">make an COMEDI sink. <a href="#a0abddd0a4a85930752816fbed0bf98eb"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>sink using COMEDI </p>
<p>The sink has one input stream of signed short integers.</p>
<p>Input samples must be in the range [-32768,32767]. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a1e267c1c193ef6dc2c743c66f802aaa5"></a><!-- doxytag: member="comedi_sink_s::comedi_sink_s" ref="a1e267c1c193ef6dc2c743c66f802aaa5" args="(int sampling_freq, const std::string device_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">comedi_sink_s::comedi_sink_s </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>sampling_freq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string </td>
<td class="paramname"> <em>device_name</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="ad82c337d0b3327fde04ac0db538c1a1d"></a><!-- doxytag: member="comedi_sink_s::~comedi_sink_s" ref="ad82c337d0b3327fde04ac0db538c1a1d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">comedi_sink_s::~comedi_sink_s </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="a647ad3908c6b40ef9d4a79853b226bcf"></a><!-- doxytag: member="comedi_sink_s::check_topology" ref="a647ad3908c6b40ef9d4a79853b226bcf" 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> comedi_sink_s::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> [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="a9c2a0631f26f2683ae1779ce05836303"></a><!-- doxytag: member="comedi_sink_s::work" ref="a9c2a0631f26f2683ae1779ce05836303" 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 comedi_sink_s::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="a0abddd0a4a85930752816fbed0bf98eb"></a><!-- doxytag: member="comedi_sink_s::comedi_make_sink_s" ref="a0abddd0a4a85930752816fbed0bf98eb" args="(int sampling_freq, const std::string dev)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">comedi_sink_s_sptr</a> comedi_make_sink_s </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>sampling_freq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string </td>
<td class="paramname"> <em>dev</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">
<p>make an COMEDI sink. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sampling_freq</em> </td><td>sampling rate in Hz </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dev</em> </td><td>COMEDI device name, e.g., "/dev/comedi0" </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="comedi__sink__s_8h_source.html">comedi_sink_s.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:52:32 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>
