<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Yate: FSKModem Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1FSKModem.html">FSKModem</a>
</div>
</div>
<div class="contents">
<h1>FSKModem Class Reference</h1><!-- doxytag: class="TelEngine::FSKModem" -->A Frequency Shift Keying modem.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="yatemodem_8h-source.html">yatemodem.h</a>></code>
<p>
<p>
<a href="classTelEngine_1_1FSKModem-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1FSKModem.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> { <b>ETSI</b> = 0,
<b>TypeCount</b> = 1
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1FSKModem.html#f383dce9c8e08a856e970a0ab3be6f29">FSKModem</a> (const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &params, <a class="el" href="classTelEngine_1_1UART.html">UART</a> *uart)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1FSKModem.html#3ef6bb353ab7403ff0baa2c7abe3f82c">~FSKModem</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1FSKModem.html#6670bec75731f6f769bed2f86d402393">terminated</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1FSKModem.html#4609e33962a63a3b71f17de25e8745aa">type</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1FSKModem.html#d20897c5c8bd47f5d4005989bead0e55">reset</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1FSKModem.html#5b447c39dc5e071deb6e4d33f6c9af3c">demodulate</a> (const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1FSKModem.html#fdea8ef47969444723905a0ef79b6269">modulate</a> (<a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &dest, const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &data)</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1FSKModem.html#54a857dbce89ce43c1d93d2bdceb97d4">addRaw</a> (<a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &dest, void *buf, unsigned int len)</td></tr>
<tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="structTelEngine_1_1TokenDict.html">TokenDict</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1FSKModem.html#ffadd530d1e93767ef3bfbad2f4b754d">s_typeName</a> []</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A Frequency Shift Keying modem.
<p>
This is a modulator/demodulator class attached to an <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a>. Used to demodulate bits from frequency modulated signal and send them to an <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a> <hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="1d1cfd8ffb84e947f82999c682b666a7"></a><!-- doxytag: member="TelEngine::FSKModem::Type" ref="1d1cfd8ffb84e947f82999c682b666a7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classTelEngine_1_1FSKModem.html#1d1cfd8ffb84e947f82999c682b666a7">Type</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Modem type enumeration
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="f383dce9c8e08a856e970a0ab3be6f29"></a><!-- doxytag: member="TelEngine::FSKModem::FSKModem" ref="f383dce9c8e08a856e970a0ab3be6f29" args="(const NamedList &params, UART *uart)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1FSKModem.html">FSKModem</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> & </td>
<td class="paramname"> <em>params</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1UART.html">UART</a> * </td>
<td class="paramname"> <em>uart</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>params</em> </td><td>Modem parameters (including modemtype) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>uart</em> </td><td>The <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a> attached to this modem </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="3ef6bb353ab7403ff0baa2c7abe3f82c"></a><!-- doxytag: member="TelEngine::FSKModem::~FSKModem" ref="3ef6bb353ab7403ff0baa2c7abe3f82c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classTelEngine_1_1FSKModem.html">FSKModem</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="54a857dbce89ce43c1d93d2bdceb97d4"></a><!-- doxytag: member="TelEngine::FSKModem::addRaw" ref="54a857dbce89ce43c1d93d2bdceb97d4" args="(DataBlock &dest, void *buf, unsigned int len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void addRaw </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> & </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>len</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Append a raw buffer to a data block <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>Destination buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>Buffer to append to destination </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>the number of bytes to append starting with buf </td></tr>
</table>
</dl>
<p>References <a class="el" href="classTelEngine_1_1DataBlock.html#7927d7a1ef8f8c13a1ba9d90ad352c49">DataBlock::clear()</a>.</p>
</div>
</div><p>
<a class="anchor" name="5b447c39dc5e071deb6e4d33f6c9af3c"></a><!-- doxytag: member="TelEngine::FSKModem::demodulate" ref="5b447c39dc5e071deb6e4d33f6c9af3c" args="(const DataBlock &data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool demodulate </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> & </td>
<td class="paramname"> <em>data</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Data processor. Demodulate received data. Feed the <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a> with received bits <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>The data to process </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False to stop feedding data (terminated) </dd></dl>
</div>
</div><p>
<a class="anchor" name="fdea8ef47969444723905a0ef79b6269"></a><!-- doxytag: member="TelEngine::FSKModem::modulate" ref="fdea8ef47969444723905a0ef79b6269" args="(DataBlock &dest, const DataBlock &data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void modulate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> & </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> & </td>
<td class="paramname"> <em>data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a buffer containing the modulated representation of a message. A data pattern (depending on modem's type) will be added before the message. A mark pattern (2ms long) will be added after the message. Reset the modem before each request to modulate <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>Destination buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td><a class="el" href="classTelEngine_1_1Message.html" title="A message container class.">Message</a> data (each byte will be enclosed in start/stop/parity bits) </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="d20897c5c8bd47f5d4005989bead0e55"></a><!-- doxytag: member="TelEngine::FSKModem::reset" ref="d20897c5c8bd47f5d4005989bead0e55" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void reset </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reset modem to its initial state
</div>
</div><p>
<a class="anchor" name="6670bec75731f6f769bed2f86d402393"></a><!-- doxytag: member="TelEngine::FSKModem::terminated" ref="6670bec75731f6f769bed2f86d402393" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool terminated </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if this modem is terminated. Need reset if so. The modem can terminate processing on UART's request <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if this modem is terminated </dd></dl>
</div>
</div><p>
<a class="anchor" name="4609e33962a63a3b71f17de25e8745aa"></a><!-- doxytag: member="TelEngine::FSKModem::type" ref="4609e33962a63a3b71f17de25e8745aa" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int type </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the type of this modem <dl class="return" compact><dt><b>Returns:</b></dt><dd>The modem type </dd></dl>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="ffadd530d1e93767ef3bfbad2f4b754d"></a><!-- doxytag: member="TelEngine::FSKModem::s_typeName" ref="ffadd530d1e93767ef3bfbad2f4b754d" args="[]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structTelEngine_1_1TokenDict.html">TokenDict</a> <a class="el" href="classTelEngine_1_1FSKModem.html#ffadd530d1e93767ef3bfbad2f4b754d">s_typeName</a>[]<code> [static]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Keep the modem type names. Useful to configure the modem
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yatemodem_8h-source.html">yatemodem.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:13 2008 for Yate by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
eeacaa4eb55fa544d622989e42fc27b1
>
files
>
119
