<!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: DataConsumer 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_1DataConsumer.html">DataConsumer</a>
</div>
</div>
<div class="contents">
<h1>DataConsumer Class Reference</h1><!-- doxytag: class="TelEngine::DataConsumer" --><!-- doxytag: inherits="TelEngine::DataNode" --><code>#include <<a class="el" href="yatephone_8h-source.html">yatephone.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for DataConsumer:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1DataConsumer.png" usemap="#DataConsumer_map" border="0" alt=""></center>
<map name="DataConsumer_map">
<area href="classTelEngine_1_1DataNode.html" alt="DataNode" shape="rect" coords="0,112,95,136">
<area href="classTelEngine_1_1RefObject.html" alt="RefObject" shape="rect" coords="0,56,95,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,95,24">
<area href="classTelEngine_1_1DataTranslator.html" alt="DataTranslator" shape="rect" coords="0,224,95,248">
</map>
</div>
<p>
<a href="classTelEngine_1_1DataConsumer-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 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_1DataConsumer.html#1670b25e53861c9b44639d964ef8f90d">DataConsumer</a> (const char *format="slin")</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_1DataConsumer.html#29e169c1327513d2db6127ddb301dc19">destroyed</a> ()</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_1DataConsumer.html#aa71c3294b1a073c3ad0b64a2ed6325a">getObject</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &name) 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_1DataConsumer.html#264cf55fb863e2b9175100c597ab07d5">Consume</a> (const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> &data, unsigned long tStamp)=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1DataSource.html">DataSource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataConsumer.html#2691f363b73412e4952a025dc512aedc">getConnSource</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1DataSource.html">DataSource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataConsumer.html#2f0bcd128c1ad220af924c6a83cfb477">getOverSource</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classTelEngine_1_1DataSource.html">DataSource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataConsumer.html#62f27df35e897ffa333df4ea7512c210">getTransSource</a> () const </td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></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_1DataConsumer.html#c262f089839a46664b1e597bc7b9b0f0">synchronize</a> (<a class="el" href="classTelEngine_1_1DataSource.html">DataSource</a> *source)</td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7998ddaa8bd7c3b9a7cd2a8cbf3573c4"></a><!-- doxytag: member="TelEngine::DataConsumer::DataSource" ref="7998ddaa8bd7c3b9a7cd2a8cbf3573c4" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>DataSource</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A data consumer <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="1670b25e53861c9b44639d964ef8f90d"></a><!-- doxytag: member="TelEngine::DataConsumer::DataConsumer" ref="1670b25e53861c9b44639d964ef8f90d" args="(const char *format="slin")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1DataConsumer.html">DataConsumer</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>format</em> = <code>"slin"</code> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Consumer 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>format</em> </td><td>Name of the data format, default "slin" (Signed Linear) </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="264cf55fb863e2b9175100c597ab07d5"></a><!-- doxytag: member="TelEngine::DataConsumer::Consume" ref="264cf55fb863e2b9175100c597ab07d5" args="(const DataBlock &data, unsigned long tStamp)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Consume </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>tStamp</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Consumes the data sent to it from a source <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 raw data block to process; an empty block ends data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tStamp</em> </td><td>Timestamp of data - typically samples </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="29e169c1327513d2db6127ddb301dc19"></a><!-- doxytag: member="TelEngine::DataConsumer::destroyed" ref="29e169c1327513d2db6127ddb301dc19" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void destroyed </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destruct notification - complains loudly if still attached to a source
<p>Reimplemented from <a class="el" href="classTelEngine_1_1RefObject.html#29e169c1327513d2db6127ddb301dc19">RefObject</a>.</p>
</div>
</div><p>
<a class="anchor" name="2691f363b73412e4952a025dc512aedc"></a><!-- doxytag: member="TelEngine::DataConsumer::getConnSource" ref="2691f363b73412e4952a025dc512aedc" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1DataSource.html">DataSource</a>* getConnSource </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 source of this object if it's connected <dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the <a class="el" href="classTelEngine_1_1DataSource.html">DataSource</a> object or NULL </dd></dl>
</div>
</div><p>
<a class="anchor" name="aa71c3294b1a073c3ad0b64a2ed6325a"></a><!-- doxytag: member="TelEngine::DataConsumer::getObject" ref="aa71c3294b1a073c3ad0b64a2ed6325a" args="(const String &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void* getObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a pointer to a derived class given that class name <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of the class we are asking for </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the requested class or NULL if this object doesn't implement it </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1GenObject.html#aa71c3294b1a073c3ad0b64a2ed6325a">GenObject</a>.</p>
<p>Reimplemented in <a class="el" href="classTelEngine_1_1DataTranslator.html#aa71c3294b1a073c3ad0b64a2ed6325a">DataTranslator</a>.</p>
</div>
</div><p>
<a class="anchor" name="2f0bcd128c1ad220af924c6a83cfb477"></a><!-- doxytag: member="TelEngine::DataConsumer::getOverSource" ref="2f0bcd128c1ad220af924c6a83cfb477" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1DataSource.html">DataSource</a>* getOverSource </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the override data source of this object if it's connected <dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the <a class="el" href="classTelEngine_1_1DataSource.html">DataSource</a> object or NULL </dd></dl>
</div>
</div><p>
<a class="anchor" name="62f27df35e897ffa333df4ea7512c210"></a><!-- doxytag: member="TelEngine::DataConsumer::getTransSource" ref="62f27df35e897ffa333df4ea7512c210" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classTelEngine_1_1DataSource.html">DataSource</a>* getTransSource </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the data source of a translator object <dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the <a class="el" href="classTelEngine_1_1DataSource.html">DataSource</a> object or NULL </dd></dl>
<p>Reimplemented in <a class="el" href="classTelEngine_1_1DataTranslator.html#62f27df35e897ffa333df4ea7512c210">DataTranslator</a>.</p>
</div>
</div><p>
<a class="anchor" name="c262f089839a46664b1e597bc7b9b0f0"></a><!-- doxytag: member="TelEngine::DataConsumer::synchronize" ref="c262f089839a46664b1e597bc7b9b0f0" args="(DataSource *source)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool synchronize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1DataSource.html">DataSource</a> * </td>
<td class="paramname"> <em>source</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Synchronize the consumer with a source <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>Data source to copy the timestamp from </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if we could synchronize with the source </dd></dl>
<p>Reimplemented in <a class="el" href="classTelEngine_1_1DataTranslator.html#c262f089839a46664b1e597bc7b9b0f0">DataTranslator</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yatephone_8h-source.html">yatephone.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:12 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
>
85
