<!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: comedi_source_s.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('comedi__source__s_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">comedi_source_s.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="comedi__source__s_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 2005 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> <span class="preprocessor">#ifndef INCLUDED_COMEDI_SOURCE_S_H</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_COMEDI_SOURCE_S_H</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</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="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <comedilib.h></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <stdexcept></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">class </span><a class="code" href="classcomedi__source__s.html" title="source using COMEDI">comedi_source_s</a>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<comedi_source_s></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">comedi_source_s_sptr</a>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"></span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">/*!</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * \brief make a COMEDI source.</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * \param sampling_freq sampling rate in Hz</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * \param dev COMEDI device name, e.g., "/dev/comedi0"</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">comedi_source_s_sptr</a></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <a class="code" href="comedi__source__s_8h.html#a50c1bec557b16f3cf9f5b34326d1ca5c" title="make a COMEDI source.">comedi_make_source_s</a> (<span class="keywordtype">int</span> sampling_freq,</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">const</span> std::string dev = <span class="stringliteral">"/dev/comedi0"</span>);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"></span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">/*!</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * \brief source using COMEDI</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"> * The source has one to many input stream of signed short integers.</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * Output samples will be in the range [-32768,32767].</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"><a class="code" href="classcomedi__source__s.html"> 50</a></span> <span class="keyword">class </span><a class="code" href="classcomedi__source__s.html" title="source using COMEDI">comedi_source_s</a> : <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="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">comedi_source_s_sptr</a></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="classcomedi__source__s.html#a5bb57cf5bed3634d7b2f0f36da737981" title="make a COMEDI source.">comedi_make_source_s</a> (<span class="keywordtype">int</span> sampling_freq, <span class="keyword">const</span> std::string dev);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// typedef for pointer to class work method</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">typedef</span> int (<a class="code" href="classcomedi__source__s.html" title="source using COMEDI">comedi_source_s</a>::*work_t)(<span class="keywordtype">int</span> noutput_items,</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="gr__types_8h.html#a9852a3d906d823cb70eb9c29e7f2a43d">gr_vector_const_void_star</a> &input_items,</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="gr__types_8h.html#acd3f499576e769966ea44554b359d949">gr_vector_void_star</a> &output_items);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_sampling_freq;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  std::string d_device_name;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  comedi_t *d_dev;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">int</span> d_subdevice;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">int</span> d_n_chan;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">void</span> *d_map;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">int</span> d_buffer_size;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">unsigned</span> d_buf_front;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">unsigned</span> d_buf_back;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// random stats</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">int</span> d_noverruns; <span class="comment">// count of overruns</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">void</span> output_error_msg (<span class="keyword">const</span> <span class="keywordtype">char</span> *msg, <span class="keywordtype">int</span> err);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">void</span> bail (<span class="keyword">const</span> <span class="keywordtype">char</span> *msg, <span class="keywordtype">int</span> err) <span class="keywordflow">throw</span> (std::runtime_error);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="classcomedi__source__s.html#a91c49fb25bea1524b0d1dca3ea179645">comedi_source_s</a> (<span class="keywordtype">int</span> sampling_freq, <span class="keyword">const</span> std::string device_name);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="classcomedi__source__s.html#a3fd4a83244906bff6e44edafe38d324f">~comedi_source_s</a> ();</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">bool</span> <a class="code" href="classcomedi__source__s.html#aff742e2bf9b208cf2b76dfe9eaad1ff9" title="Confirm that ninputs and noutputs is an acceptable combination.">check_topology</a> (<span class="keywordtype">int</span> ninputs, <span class="keywordtype">int</span> noutputs);</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">int</span> <a class="code" href="classcomedi__source__s.html#a26d276fe12a39b6c99fca35cd7772eec" title="just like gr_block::general_work, only this arranges to call consume_each for you">work</a> (<span class="keywordtype">int</span> noutput_items,</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="code" href="gr__types_8h.html#a9852a3d906d823cb70eb9c29e7f2a43d">gr_vector_const_void_star</a> &input_items,</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="gr__types_8h.html#acd3f499576e769966ea44554b359d949">gr_vector_void_star</a> &output_items);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> };</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_COMEDI_SOURCE_S_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_dd5eb6a0dfc592607dc7e05d120e00cb.html">gr-comedi</a></li><li class="navelem"><a class="el" href="dir_72de54bf6a65c764899ce5326f7deb8e.html">src</a></li><li class="navelem"><a class="el" href="comedi__source__s_8h.html">comedi_source_s.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>
