<!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: UART 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_1UART.html">UART</a>
</div>
</div>
<div class="contents">
<h1>UART Class Reference</h1><!-- doxytag: class="TelEngine::UART" --><!-- doxytag: inherits="TelEngine::DebugEnabler" -->An <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a> receiver/transmitter.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="yatemodem_8h-source.html">yatemodem.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for UART:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1UART.png" usemap="#UART_map" border="0" alt=""></center>
<map name="UART_map">
<area href="classTelEngine_1_1DebugEnabler.html" alt="DebugEnabler" shape="rect" coords="0,0,93,24">
<area href="classTelEngine_1_1ETSIModem.html" alt="ETSIModem" shape="rect" coords="0,112,93,136">
</map>
</div>
<p>
<a href="classTelEngine_1_1UART-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_1UART.html#5d74787dedbc4e11c1ab15bf487e61f8">State</a> { <br>
<b>Idle</b>,
<b>BitStart</b>,
<b>BitData</b>,
<b>BitParity</b>,
<br>
<b>BitStop</b>,
<b>UARTError</b>
<br>
}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1UART.html#2c3e4bb40f36b262a5214e2da2bca9c5">Error</a> { <br>
<b>EFraming</b>,
<b>EParity</b>,
<b>EChksum</b>,
<b>EInvalidData</b>,
<br>
<b>EUnknown</b>,
<b>EStopped</b>,
<b>ENone</b>
<br>
}</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_1UART.html#a4e437bb218690128fbff1966791ef72">UART</a> (<a class="el" href="classTelEngine_1_1UART.html#5d74787dedbc4e11c1ab15bf487e61f8">State</a> state, const <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &params, const char *name=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1UART.html#a17b513b37b54eb08699870d19b29501">~UART</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1UART.html#5d74787dedbc4e11c1ab15bf487e61f8">State</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1UART.html#3804c9648e6d1325751536cca350f2bf">state</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1UART.html#2c3e4bb40f36b262a5214e2da2bca9c5">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1UART.html#6c0803d83827f0d9aa8be11472c6c542">error</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_1UART.html#58042723326c2296bec27ecf08fcbc27">modemType</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1BitAccumulator.html">BitAccumulator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1UART.html#3828c3e3be53039a07e077ab82a7d0b2">accumulator</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1UART.html#40cde7507987a84e4533628e256056cc">reset</a> (<a class="el" href="classTelEngine_1_1UART.html#5d74787dedbc4e11c1ab15bf487e61f8">State</a> newState=Idle)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1UART.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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1UART.html#c75c7402a4fc83bf4987c13ca8aacfa3">modulate</a> (<a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &dest, <a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &params)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1UART.html#d914cd566b8351615165d3b3054f4eab">modulate</a> (<a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &dest, const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &src)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1UART.html#b59ab4624541b30fb8dad4e9e5c92779">recvBit</a> (bool value)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1UART.html#2b2c72d82aa0d491bd8b474058bb7386">recvByte</a> (unsigned char data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1UART.html#69ebd093d2dd1d0a5a5dd738ac576c38">fskStarted</a> ()</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_1UART.html#6ddd6252fb312fddd0709b0c0411a3e5">s_errors</a> []</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1UART.html#9176044928486fb38fca7adc5804cd29">idleRecvByte</a> (unsigned char data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1UART.html#75cfe67ac70886275dbb6b997b1674ae">createMsg</a> (<a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &params, <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1UART.html#614efd178203bbd2ac7ae1055a31798f">error</a> (<a class="el" href="classTelEngine_1_1UART.html#2c3e4bb40f36b262a5214e2da2bca9c5">Error</a> e)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a> receiver/transmitter.
<p>
Accumulate data bits received from a modem <hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="2c3e4bb40f36b262a5214e2da2bca9c5"></a><!-- doxytag: member="TelEngine::UART::Error" ref="2c3e4bb40f36b262a5214e2da2bca9c5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classTelEngine_1_1UART.html#2c3e4bb40f36b262a5214e2da2bca9c5">Error</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a> error enumeration
</div>
</div><p>
<a class="anchor" name="5d74787dedbc4e11c1ab15bf487e61f8"></a><!-- doxytag: member="TelEngine::UART::State" ref="5d74787dedbc4e11c1ab15bf487e61f8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classTelEngine_1_1UART.html#5d74787dedbc4e11c1ab15bf487e61f8">State</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a> state enumeration
<p>Reimplemented in <a class="el" href="classTelEngine_1_1ETSIModem.html#5d74787dedbc4e11c1ab15bf487e61f8">ETSIModem</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a4e437bb218690128fbff1966791ef72"></a><!-- doxytag: member="TelEngine::UART::UART" ref="a4e437bb218690128fbff1966791ef72" args="(State state, const NamedList &params, const char *name=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1UART.html">UART</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1UART.html#5d74787dedbc4e11c1ab15bf487e61f8">State</a> </td>
<td class="paramname"> <em>state</em>, </td>
</tr>
<tr>
<td class="paramkey"></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">const char * </td>
<td class="paramname"> <em>name</em> = <code>0</code></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>state</em> </td><td>The initial state of this <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params</em> </td><td>The UART's parameters </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of this debug enabler </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a17b513b37b54eb08699870d19b29501"></a><!-- doxytag: member="TelEngine::UART::~UART" ref="a17b513b37b54eb08699870d19b29501" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classTelEngine_1_1UART.html">UART</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="3828c3e3be53039a07e077ab82a7d0b2"></a><!-- doxytag: member="TelEngine::UART::accumulator" ref="3828c3e3be53039a07e077ab82a7d0b2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classTelEngine_1_1BitAccumulator.html">BitAccumulator</a>& accumulator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the data bit accumulator used by this <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The data bit accumulator used by this <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="75cfe67ac70886275dbb6b997b1674ae"></a><!-- doxytag: member="TelEngine::UART::createMsg" ref="75cfe67ac70886275dbb6b997b1674ae" args="(NamedList &params, DataBlock &data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool createMsg </td>
<td>(</td>
<td class="paramtype"><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_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><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a buffer containing the byte representation of a message to be sent <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>The list containing message parameters </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Destination message data buffer </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False on failure </dd></dl>
<p>Reimplemented in <a class="el" href="classTelEngine_1_1ETSIModem.html#75cfe67ac70886275dbb6b997b1674ae">ETSIModem</a>.</p>
</div>
</div><p>
<a class="anchor" name="5b447c39dc5e071deb6e4d33f6c9af3c"></a><!-- doxytag: member="TelEngine::UART::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><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Send data to the enclosed modem to be demodulated <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 processing </dd></dl>
</div>
</div><p>
<a class="anchor" name="614efd178203bbd2ac7ae1055a31798f"></a><!-- doxytag: member="TelEngine::UART::error" ref="614efd178203bbd2ac7ae1055a31798f" args="(Error e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool error </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1UART.html#2c3e4bb40f36b262a5214e2da2bca9c5">Error</a> </td>
<td class="paramname"> <em>e</em> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the error state of this <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a> <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>e</em> </td><td>The error </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False </dd></dl>
</div>
</div><p>
<a class="anchor" name="6c0803d83827f0d9aa8be11472c6c542"></a><!-- doxytag: member="TelEngine::UART::error" ref="6c0803d83827f0d9aa8be11472c6c542" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1UART.html#2c3e4bb40f36b262a5214e2da2bca9c5">Error</a> error </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the current error state of this <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a>, if any <dl class="return" compact><dt><b>Returns:</b></dt><dd>The current error state of this <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a> as enumeration </dd></dl>
</div>
</div><p>
<a class="anchor" name="69ebd093d2dd1d0a5a5dd738ac576c38"></a><!-- doxytag: member="TelEngine::UART::fskStarted" ref="69ebd093d2dd1d0a5a5dd738ac576c38" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool fskStarted </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Notification from modem that the FSK start was detected <dl class="return" compact><dt><b>Returns:</b></dt><dd>False to stop the modem </dd></dl>
</div>
</div><p>
<a class="anchor" name="9176044928486fb38fca7adc5804cd29"></a><!-- doxytag: member="TelEngine::UART::idleRecvByte" ref="9176044928486fb38fca7adc5804cd29" args="(unsigned char data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int idleRecvByte </td>
<td>(</td>
<td class="paramtype">unsigned char </td>
<td class="paramname"> <em>data</em> </td>
<td> ) </td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Process an accumulated byte in Idle state <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 byte to process </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Negative to stop, positive to change state to BitStart, 0 to continue </dd></dl>
<p>Reimplemented in <a class="el" href="classTelEngine_1_1ETSIModem.html#9176044928486fb38fca7adc5804cd29">ETSIModem</a>.</p>
</div>
</div><p>
<a class="anchor" name="58042723326c2296bec27ecf08fcbc27"></a><!-- doxytag: member="TelEngine::UART::modemType" ref="58042723326c2296bec27ecf08fcbc27" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int modemType </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 UART's modem <dl class="return" compact><dt><b>Returns:</b></dt><dd>The type of this UART's modem </dd></dl>
</div>
</div><p>
<a class="anchor" name="d914cd566b8351615165d3b3054f4eab"></a><!-- doxytag: member="TelEngine::UART::modulate" ref="d914cd566b8351615165d3b3054f4eab" args="(DataBlock &dest, const DataBlock &src)" -->
<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>src</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a buffer containing the modulated representation of another one <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>src</em> </td><td>Source buffer </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="c75c7402a4fc83bf4987c13ca8aacfa3"></a><!-- doxytag: member="TelEngine::UART::modulate" ref="c75c7402a4fc83bf4987c13ca8aacfa3" args="(DataBlock &dest, NamedList &params)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool 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"><a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> & </td>
<td class="paramname"> <em>params</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a buffer containing the modulated representation of a list of parameters <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>params</em> </td><td>The list containing the values to be modulated </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False on failure (an 'error' parameter will be set in params) </dd></dl>
</div>
</div><p>
<a class="anchor" name="b59ab4624541b30fb8dad4e9e5c92779"></a><!-- doxytag: member="TelEngine::UART::recvBit" ref="b59ab4624541b30fb8dad4e9e5c92779" args="(bool value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool recvBit </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>value</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Push a bit of data into this <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a>. Once a data byte is accumulated, push it back to itself <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>The bit to be processed </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False to stop feeding data </dd></dl>
</div>
</div><p>
<a class="anchor" name="2b2c72d82aa0d491bd8b474058bb7386"></a><!-- doxytag: member="TelEngine::UART::recvByte" ref="2b2c72d82aa0d491bd8b474058bb7386" args="(unsigned char data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool recvByte </td>
<td>(</td>
<td class="paramtype">unsigned char </td>
<td class="paramname"> <em>data</em> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Push a data byte into this <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a> <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 byte to be processed </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False to stop feeding data </dd></dl>
<p>Reimplemented in <a class="el" href="classTelEngine_1_1ETSIModem.html#2b2c72d82aa0d491bd8b474058bb7386">ETSIModem</a>.</p>
</div>
</div><p>
<a class="anchor" name="40cde7507987a84e4533628e256056cc"></a><!-- doxytag: member="TelEngine::UART::reset" ref="40cde7507987a84e4533628e256056cc" args="(State newState=Idle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1UART.html#5d74787dedbc4e11c1ab15bf487e61f8">State</a> </td>
<td class="paramname"> <em>newState</em> = <code>Idle</code> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reset this <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a> <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>newState</em> </td><td>The state to reset to </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="3804c9648e6d1325751536cca350f2bf"></a><!-- doxytag: member="TelEngine::UART::state" ref="3804c9648e6d1325751536cca350f2bf" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1UART.html#5d74787dedbc4e11c1ab15bf487e61f8">State</a> state </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the current state of this <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The current state of this <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a> as enumeration </dd></dl>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="6ddd6252fb312fddd0709b0c0411a3e5"></a><!-- doxytag: member="TelEngine::UART::s_errors" ref="6ddd6252fb312fddd0709b0c0411a3e5" 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_1UART.html#6ddd6252fb312fddd0709b0c0411a3e5">s_errors</a>[]<code> [static]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Keeps the names associated with <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a> errors
</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
>
641
