Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 1949

gnuradio-doc-3.2.2-9.fc14.x86_64.rpm

<!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_sig_source_c Class Reference</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('classgr__sig__source__c.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a>  </div>
  <div class="headertitle">
<h1>gr_sig_source_c Class Reference<div class="ingroups"><a class="el" href="group__source__blk.html">Signal Sources</a></div></h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="gr_sig_source_c" --><!-- doxytag: inherits="gr_sync_block" -->
<p>signal generator with gr_complex output.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="gr__sig__source__c_8h_source.html">gr_sig_source_c.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for gr_sig_source_c:</div>
<div class="dyncontent">
<div class="center"><img src="classgr__sig__source__c__inherit__graph.png" border="0" usemap="#gr__sig__source__c_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__sig__source__c_inherit__map" id="gr__sig__source__c_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 implementa..." alt="" coords="11,160,117,189"/><area shape="rect" id="node4" href="classgr__block.html" title="The abstract base class for all &#39;terminal&#39; processing blocks.A signal processing flow is cons..." alt="" coords="29,83,99,112"/><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 abstraction of an ..." alt="" coords="9,5,119,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classgr__sig__source__c-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__c.html#acf812b208cd045c9852ee1d9c001ae91">work</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &amp;input_items, <a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> &amp;output_items)</td></tr>
<tr><td class="mdescLeft">&#160;</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="#acf812b208cd045c9852ee1d9c001ae91"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__c.html#a6fed2e40327d536a490b524fc53e26ad">sampling_freq</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gr__sig__source__waveform_8h.html#af014e40721bc5a916be04d8ce1d8b9b6">gr_waveform_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__c.html#a2c93992b4f9065e864ee76952a5e5461">waveform</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__c.html#a1aa30f04a1fb8885b94d7d546caea1d7">frequency</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__c.html#a8a7646e50930feec1bb8d76c17cc568b">amplitude</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__c.html#a036d9fc6638b8a61dd2664b4abb6e19b">offset</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__c.html#a814f75a677b1b4bd478adf98673c435d">set_sampling_freq</a> (double sampling_freq)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__c.html#af771102e383d4f624e92bcf17c9dad8f">set_waveform</a> (<a class="el" href="gr__sig__source__waveform_8h.html#af014e40721bc5a916be04d8ce1d8b9b6">gr_waveform_t</a> waveform)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__c.html#a4f6fc55357d4bd5836e2f1cee2554ef1">set_frequency</a> (double frequency)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__c.html#a105e306c4cf9e99ab612fd26989edfd1">set_amplitude</a> (double ampl)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__c.html#aa41ce16bd377686861bbd9b583f802f7">set_offset</a> (<a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> offset)</td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_sig_source_c_sptr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__c.html#abe8a123e69fd773a27cb0adc20432e77">gr_make_sig_source_c</a> (double sampling_freq, <a class="el" href="gr__sig__source__waveform_8h.html#af014e40721bc5a916be04d8ce1d8b9b6">gr_waveform_t</a> waveform, double frequency, double ampl, <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> offset)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>signal generator with gr_complex output. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8a7646e50930feec1bb8d76c17cc568b"></a><!-- doxytag: member="gr_sig_source_c::amplitude" ref="a8a7646e50930feec1bb8d76c17cc568b" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double gr_sig_source_c::amplitude </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a1aa30f04a1fb8885b94d7d546caea1d7"></a><!-- doxytag: member="gr_sig_source_c::frequency" ref="a1aa30f04a1fb8885b94d7d546caea1d7" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double gr_sig_source_c::frequency </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a036d9fc6638b8a61dd2664b4abb6e19b"></a><!-- doxytag: member="gr_sig_source_c::offset" ref="a036d9fc6638b8a61dd2664b4abb6e19b" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> gr_sig_source_c::offset </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a6fed2e40327d536a490b524fc53e26ad"></a><!-- doxytag: member="gr_sig_source_c::sampling_freq" ref="a6fed2e40327d536a490b524fc53e26ad" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double gr_sig_source_c::sampling_freq </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a105e306c4cf9e99ab612fd26989edfd1"></a><!-- doxytag: member="gr_sig_source_c::set_amplitude" ref="a105e306c4cf9e99ab612fd26989edfd1" args="(double ampl)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void gr_sig_source_c::set_amplitude </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>ampl</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a4f6fc55357d4bd5836e2f1cee2554ef1"></a><!-- doxytag: member="gr_sig_source_c::set_frequency" ref="a4f6fc55357d4bd5836e2f1cee2554ef1" args="(double frequency)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void gr_sig_source_c::set_frequency </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>frequency</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="aa41ce16bd377686861bbd9b583f802f7"></a><!-- doxytag: member="gr_sig_source_c::set_offset" ref="aa41ce16bd377686861bbd9b583f802f7" args="(gr_complex offset)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void gr_sig_source_c::set_offset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>&#160;</td>
          <td class="paramname"><em>offset</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a814f75a677b1b4bd478adf98673c435d"></a><!-- doxytag: member="gr_sig_source_c::set_sampling_freq" ref="a814f75a677b1b4bd478adf98673c435d" args="(double sampling_freq)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void gr_sig_source_c::set_sampling_freq </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>sampling_freq</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="af771102e383d4f624e92bcf17c9dad8f"></a><!-- doxytag: member="gr_sig_source_c::set_waveform" ref="af771102e383d4f624e92bcf17c9dad8f" args="(gr_waveform_t waveform)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void gr_sig_source_c::set_waveform </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="gr__sig__source__waveform_8h.html#af014e40721bc5a916be04d8ce1d8b9b6">gr_waveform_t</a>&#160;</td>
          <td class="paramname"><em>waveform</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a2c93992b4f9065e864ee76952a5e5461"></a><!-- doxytag: member="gr_sig_source_c::waveform" ref="a2c93992b4f9065e864ee76952a5e5461" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="gr__sig__source__waveform_8h.html#af014e40721bc5a916be04d8ce1d8b9b6">gr_waveform_t</a> gr_sig_source_c::waveform </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="acf812b208cd045c9852ee1d9c001ae91"></a><!-- doxytag: member="gr_sig_source_c::work" ref="acf812b208cd045c9852ee1d9c001ae91" args="(int noutput_items, gr_vector_const_void_star &amp;input_items, gr_vector_void_star &amp;output_items)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int gr_sig_source_c::work </td>
          <td>(</td>
          <td class="paramtype">int&#160;</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> &amp;&#160;</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> &amp;&#160;</td>
          <td class="paramname"><em>output_items</em>&#160;</td>
        </tr>
        <tr>
          <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="abe8a123e69fd773a27cb0adc20432e77"></a><!-- doxytag: member="gr_sig_source_c::gr_make_sig_source_c" ref="abe8a123e69fd773a27cb0adc20432e77" args="(double sampling_freq, gr_waveform_t waveform, double frequency, double ampl, gr_complex offset)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_sig_source_c_sptr</a> gr_make_sig_source_c </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>sampling_freq</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="gr__sig__source__waveform_8h.html#af014e40721bc5a916be04d8ce1d8b9b6">gr_waveform_t</a>&#160;</td>
          <td class="paramname"><em>waveform</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>frequency</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>ampl</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>&#160;</td>
          <td class="paramname"><em>offset</em>&#160;</td>
        </tr>
        <tr>
          <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__sig__source__c_8h_source.html">gr_sig_source_c.h</a></li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="classgr__sig__source__c.html">gr_sig_source_c</a>      </li>
      <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by&#160;
<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>