<!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_s 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__s.html',''); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#friends">Friends</a> </div> <div class="headertitle"> <h1>gr_sig_source_s 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_s" --><!-- doxytag: inherits="gr_sync_block" --> <p>signal generator with short output. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="gr__sig__source__s_8h_source.html">gr_sig_source_s.h</a>></code></p> <div class="dynheader"> Inheritance diagram for gr_sig_source_s:</div> <div class="dyncontent"> <div class="center"><img src="classgr__sig__source__s__inherit__graph.png" border="0" usemap="#gr__sig__source__s_inherit__map" alt="Inheritance graph"/></div> <map name="gr__sig__source__s_inherit__map" id="gr__sig__source__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 implementa..." alt="" coords="11,160,117,189"/><area shape="rect" id="node4" href="classgr__block.html" title="The abstract base class for all 'terminal' 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__s-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__s.html#a4e8de6e27e589f8607fc988b2197d659">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="#a4e8de6e27e589f8607fc988b2197d659"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__s.html#ab6a1a8b28015a314bc9eaf4313a711c6">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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__s.html#a153a8de2854ec9b26e93efee0dd16ef2">waveform</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__s.html#abb571a54492df5341cb1a4341d8e9a64">frequency</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__s.html#abaf2df505a8a28288ac11d6422018c39">amplitude</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">short </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__s.html#a5246f04a59ca5f09c54b1422d889da1e">offset</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__s.html#a185a831dac0482127dfbdadd8fdd05f9">set_sampling_freq</a> (double sampling_freq)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__s.html#ae7771543dc54feaa14582a9282545a6e">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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__s.html#ae57ecbc2b7dc9d5ab28d6d1b4e7dd7f4">set_frequency</a> (double frequency)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__s.html#a48261225986a30a2603eb7b95f516761">set_amplitude</a> (double ampl)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__s.html#a440371285e90c7ff108f462d9d955a9f">set_offset</a> (short 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_s_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__s.html#a375c32abb07944dc67f37469c1a56f30">gr_make_sig_source_s</a> (double sampling_freq, <a class="el" href="gr__sig__source__waveform_8h.html#af014e40721bc5a916be04d8ce1d8b9b6">gr_waveform_t</a> waveform, double frequency, double ampl, short offset)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"><p>signal generator with short output. </p> </div><hr/><h2>Member Function Documentation</h2> <a class="anchor" id="abaf2df505a8a28288ac11d6422018c39"></a><!-- doxytag: member="gr_sig_source_s::amplitude" ref="abaf2df505a8a28288ac11d6422018c39" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">double gr_sig_source_s::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="abb571a54492df5341cb1a4341d8e9a64"></a><!-- doxytag: member="gr_sig_source_s::frequency" ref="abb571a54492df5341cb1a4341d8e9a64" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">double gr_sig_source_s::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="a5246f04a59ca5f09c54b1422d889da1e"></a><!-- doxytag: member="gr_sig_source_s::offset" ref="a5246f04a59ca5f09c54b1422d889da1e" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">short gr_sig_source_s::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="ab6a1a8b28015a314bc9eaf4313a711c6"></a><!-- doxytag: member="gr_sig_source_s::sampling_freq" ref="ab6a1a8b28015a314bc9eaf4313a711c6" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">double gr_sig_source_s::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="a48261225986a30a2603eb7b95f516761"></a><!-- doxytag: member="gr_sig_source_s::set_amplitude" ref="a48261225986a30a2603eb7b95f516761" args="(double ampl)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_sig_source_s::set_amplitude </td> <td>(</td> <td class="paramtype">double </td> <td class="paramname"><em>ampl</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ae57ecbc2b7dc9d5ab28d6d1b4e7dd7f4"></a><!-- doxytag: member="gr_sig_source_s::set_frequency" ref="ae57ecbc2b7dc9d5ab28d6d1b4e7dd7f4" args="(double frequency)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_sig_source_s::set_frequency </td> <td>(</td> <td class="paramtype">double </td> <td class="paramname"><em>frequency</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a440371285e90c7ff108f462d9d955a9f"></a><!-- doxytag: member="gr_sig_source_s::set_offset" ref="a440371285e90c7ff108f462d9d955a9f" args="(short offset)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_sig_source_s::set_offset </td> <td>(</td> <td class="paramtype">short </td> <td class="paramname"><em>offset</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a185a831dac0482127dfbdadd8fdd05f9"></a><!-- doxytag: member="gr_sig_source_s::set_sampling_freq" ref="a185a831dac0482127dfbdadd8fdd05f9" args="(double sampling_freq)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_sig_source_s::set_sampling_freq </td> <td>(</td> <td class="paramtype">double </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="ae7771543dc54feaa14582a9282545a6e"></a><!-- doxytag: member="gr_sig_source_s::set_waveform" ref="ae7771543dc54feaa14582a9282545a6e" args="(gr_waveform_t waveform)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_sig_source_s::set_waveform </td> <td>(</td> <td class="paramtype"><a class="el" href="gr__sig__source__waveform_8h.html#af014e40721bc5a916be04d8ce1d8b9b6">gr_waveform_t</a> </td> <td class="paramname"><em>waveform</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a153a8de2854ec9b26e93efee0dd16ef2"></a><!-- doxytag: member="gr_sig_source_s::waveform" ref="a153a8de2854ec9b26e93efee0dd16ef2" 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_s::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="a4e8de6e27e589f8607fc988b2197d659"></a><!-- doxytag: member="gr_sig_source_s::work" ref="a4e8de6e27e589f8607fc988b2197d659" 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">virtual int gr_sig_source_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> </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="a375c32abb07944dc67f37469c1a56f30"></a><!-- doxytag: member="gr_sig_source_s::gr_make_sig_source_s" ref="a375c32abb07944dc67f37469c1a56f30" args="(double sampling_freq, gr_waveform_t waveform, double frequency, double ampl, short 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_s_sptr</a> gr_make_sig_source_s </td> <td>(</td> <td class="paramtype">double </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> </td> <td class="paramname"><em>waveform</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double </td> <td class="paramname"><em>frequency</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double </td> <td class="paramname"><em>ampl</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">short </td> <td class="paramname"><em>offset</em> </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__s_8h_source.html">gr_sig_source_s.h</a></li> </ul> </div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="classgr__sig__source__s.html">gr_sig_source_s</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>