<!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_f 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.2 -->
<div class="contents">
<h1>gr_sig_source_f Class Reference<br/>
<small>
[<a class="el" href="group__source__blk.html">Signal Sources</a>]</small>
</h1><!-- doxytag: class="gr_sig_source_f" --><!-- doxytag: inherits="gr_sync_block" -->
<p>signal generator with float output.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__sig__source__f_8h_source.html">gr_sig_source_f.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_sig_source_f:</div>
<div class="dynsection">
<div class="center"><img src="classgr__sig__source__f__inherit__graph.png" border="0" usemap="#gr__sig__source__f_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__sig__source__f_inherit__map" id="gr__sig__source__f_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="9,160,116,189"/><area shape="rect" id="node4" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing..." alt="" coords="28,83,97,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..." alt="" coords="8,5,117,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__sig__source__f-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">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__f.html#a1d17ec5276d66e3a228584187a97d6ac">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="#a1d17ec5276d66e3a228584187a97d6ac"></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__f.html#a9e9f834e79e3e926973279d33de7bb26">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__f.html#a14b7ca952a10bb4aa40123eaf42806f9">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__f.html#ad67ba566f0e95907f42a6791d480a4a8">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__f.html#a5fa6a2e4c1f87b7d532a6f6a528d021e">amplitude</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__f.html#aa4ff296d37f16d98503436e9af85a419">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__f.html#a364de88e61c3b79cab0b9d9f5f267a7a">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__f.html#a7fc2c5deccf192fd528f8f447805db8c">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__f.html#a8de93e947676eeb99b2561a48cac82ea">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__f.html#a0c11e9abcbe4e76dd30a40fbbe37b018">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__f.html#a24654eef10ea0e8d613a4e3f25830171">set_offset</a> (float offset)</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_sig_source_f_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sig__source__f.html#a5d8896c29759cae32304ee567e8fe028">gr_make_sig_source_f</a> (double sampling_freq, <a class="el" href="gr__sig__source__waveform_8h.html#af014e40721bc5a916be04d8ce1d8b9b6">gr_waveform_t</a> waveform, double frequency, double ampl, float offset)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>signal generator with float output. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5fa6a2e4c1f87b7d532a6f6a528d021e"></a><!-- doxytag: member="gr_sig_source_f::amplitude" ref="a5fa6a2e4c1f87b7d532a6f6a528d021e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gr_sig_source_f::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="ad67ba566f0e95907f42a6791d480a4a8"></a><!-- doxytag: member="gr_sig_source_f::frequency" ref="ad67ba566f0e95907f42a6791d480a4a8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gr_sig_source_f::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="aa4ff296d37f16d98503436e9af85a419"></a><!-- doxytag: member="gr_sig_source_f::offset" ref="aa4ff296d37f16d98503436e9af85a419" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float gr_sig_source_f::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="a9e9f834e79e3e926973279d33de7bb26"></a><!-- doxytag: member="gr_sig_source_f::sampling_freq" ref="a9e9f834e79e3e926973279d33de7bb26" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gr_sig_source_f::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="a0c11e9abcbe4e76dd30a40fbbe37b018"></a><!-- doxytag: member="gr_sig_source_f::set_amplitude" ref="a0c11e9abcbe4e76dd30a40fbbe37b018" args="(double ampl)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_sig_source_f::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="a8de93e947676eeb99b2561a48cac82ea"></a><!-- doxytag: member="gr_sig_source_f::set_frequency" ref="a8de93e947676eeb99b2561a48cac82ea" args="(double frequency)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_sig_source_f::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="a24654eef10ea0e8d613a4e3f25830171"></a><!-- doxytag: member="gr_sig_source_f::set_offset" ref="a24654eef10ea0e8d613a4e3f25830171" args="(float offset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_sig_source_f::set_offset </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>offset</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a364de88e61c3b79cab0b9d9f5f267a7a"></a><!-- doxytag: member="gr_sig_source_f::set_sampling_freq" ref="a364de88e61c3b79cab0b9d9f5f267a7a" args="(double sampling_freq)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_sig_source_f::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="a7fc2c5deccf192fd528f8f447805db8c"></a><!-- doxytag: member="gr_sig_source_f::set_waveform" ref="a7fc2c5deccf192fd528f8f447805db8c" args="(gr_waveform_t waveform)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_sig_source_f::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="a14b7ca952a10bb4aa40123eaf42806f9"></a><!-- doxytag: member="gr_sig_source_f::waveform" ref="a14b7ca952a10bb4aa40123eaf42806f9" 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_f::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="a1d17ec5276d66e3a228584187a97d6ac"></a><!-- doxytag: member="gr_sig_source_f::work" ref="a1d17ec5276d66e3a228584187a97d6ac" 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_f::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="a5d8896c29759cae32304ee567e8fe028"></a><!-- doxytag: member="gr_sig_source_f::gr_make_sig_source_f" ref="a5d8896c29759cae32304ee567e8fe028" args="(double sampling_freq, gr_waveform_t waveform, double frequency, double ampl, float 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_f_sptr</a> gr_make_sig_source_f </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">float </td>
<td class="paramname"> <em>offset</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__sig__source__f_8h_source.html">gr_sig_source_f.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>
