Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > eeacaa4eb55fa544d622989e42fc27b1 > files > 94

libyate-devel-2.0.0-2mdv2009.1.i586.rpm

<!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: DataNode 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1DataNode.html">DataNode</a>
  </div>
</div>
<div class="contents">
<h1>DataNode Class Reference</h1><!-- doxytag: class="TelEngine::DataNode" --><!-- doxytag: inherits="TelEngine::RefObject" --><code>#include &lt;<a class="el" href="yatephone_8h-source.html">yatephone.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for DataNode:</div>
<div class="dynsection">

<p><center><img src="classTelEngine_1_1DataNode.png" usemap="#DataNode_map" border="0" alt=""></center>
<map name="DataNode_map">
<area href="classTelEngine_1_1RefObject.html" alt="RefObject" shape="rect" coords="58,56,165,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="58,0,165,24">
<area href="classTelEngine_1_1DataConsumer.html" alt="DataConsumer" shape="rect" coords="0,168,107,192">
<area href="classTelEngine_1_1DataSource.html" alt="DataSource" shape="rect" coords="117,168,224,192">
<area href="classTelEngine_1_1DataTranslator.html" alt="DataTranslator" shape="rect" coords="0,224,107,248">
<area href="classTelEngine_1_1ThreadedSource.html" alt="ThreadedSource" shape="rect" coords="117,224,224,248">
</map>
</div>

<p>
<a href="classTelEngine_1_1DataNode-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataNode.html#78a5932a1472a294e514327bac642cb5">DataNode</a> (const char *format=0)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataNode.html#46c660610a0d2c6fc143d6b7082db59d">costFormat</a> (const <a class="el" href="classTelEngine_1_1DataFormat.html">DataFormat</a> &amp;format)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataNode.html#ce30d4e68cb5ae605b39fe9b619ab177">setFormat</a> (const <a class="el" href="classTelEngine_1_1DataFormat.html">DataFormat</a> &amp;format)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1DataFormat.html">DataFormat</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataNode.html#48d7da837b22b84107c8ff169727183b">getFormat</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataNode.html#48e91718430e53a72e2f26e2a19c8b93">timeStamp</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataNode.html#fc0eec9fbf964c2e6f5ed69ff77fdb52">control</a> (<a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &amp;params)</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 unsigned long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1DataNode.html#ce213bd0ffa4cbc3702aeb0ca6e51c76">invalidStamp</a> ()</td></tr>

<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d70f4ea0197b7ccbb6f67ec31091d15c"></a><!-- doxytag: member="TelEngine::DataNode::m_format" ref="d70f4ea0197b7ccbb6f67ec31091d15c" args="" -->
<a class="el" href="classTelEngine_1_1DataFormat.html">DataFormat</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_format</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="64006150a631a232836f73d60b8dd361"></a><!-- doxytag: member="TelEngine::DataNode::m_timestamp" ref="64006150a631a232836f73d60b8dd361" args="" -->
unsigned long&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_timestamp</b></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A generic data handling object <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="78a5932a1472a294e514327bac642cb5"></a><!-- doxytag: member="TelEngine::DataNode::DataNode" ref="78a5932a1472a294e514327bac642cb5" args="(const char *format=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTelEngine_1_1DataNode.html">DataNode</a>           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>format</em> = <code>0</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Construct a <a class="el" href="classTelEngine_1_1DataNode.html">DataNode</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>format</em>&nbsp;</td><td>Description of the data format, default none </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="fc0eec9fbf964c2e6f5ed69ff77fdb52"></a><!-- doxytag: member="TelEngine::DataNode::control" ref="fc0eec9fbf964c2e6f5ed69ff77fdb52" args="(NamedList &amp;params)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool control           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTelEngine_1_1NamedList.html">NamedList</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>params</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Modify node 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>params</em>&nbsp;</td><td>The list of parameters to change </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if processed </dd></dl>

</div>
</div><p>
<a class="anchor" name="46c660610a0d2c6fc143d6b7082db59d"></a><!-- doxytag: member="TelEngine::DataNode::costFormat" ref="46c660610a0d2c6fc143d6b7082db59d" args="(const DataFormat &amp;format)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int costFormat           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1DataFormat.html">DataFormat</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>format</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the computing cost of converting the data to the format asked <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>&nbsp;</td><td>Name of the format to check for </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>-1 if unsupported, 0 for native format else cost in KIPS </dd></dl>

</div>
</div><p>
<a class="anchor" name="48d7da837b22b84107c8ff169727183b"></a><!-- doxytag: member="TelEngine::DataNode::getFormat" ref="48d7da837b22b84107c8ff169727183b" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classTelEngine_1_1DataFormat.html">DataFormat</a>&amp; getFormat           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the description of the format currently in use <dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the data format </dd></dl>

</div>
</div><p>
<a class="anchor" name="ce213bd0ffa4cbc3702aeb0ca6e51c76"></a><!-- doxytag: member="TelEngine::DataNode::invalidStamp" ref="ce213bd0ffa4cbc3702aeb0ca6e51c76" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static unsigned long invalidStamp           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the internal representation of an invalid or unknown timestamp <dl class="return" compact><dt><b>Returns:</b></dt><dd>Invalid timestamp - unsigned long conversion of -1 </dd></dl>

</div>
</div><p>
<a class="anchor" name="ce30d4e68cb5ae605b39fe9b619ab177"></a><!-- doxytag: member="TelEngine::DataNode::setFormat" ref="ce30d4e68cb5ae605b39fe9b619ab177" args="(const DataFormat &amp;format)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool setFormat           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTelEngine_1_1DataFormat.html">DataFormat</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>format</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Change the format used to transfer data <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>&nbsp;</td><td>Name of the format to set for data </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the format changed successfully, false if not changed </dd></dl>

</div>
</div><p>
<a class="anchor" name="48e91718430e53a72e2f26e2a19c8b93"></a><!-- doxytag: member="TelEngine::DataNode::timeStamp" ref="48e91718430e53a72e2f26e2a19c8b93" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned long timeStamp           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the current position in the data stream <dl class="return" compact><dt><b>Returns:</b></dt><dd>Timestamp of current data position </dd></dl>

</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&nbsp;
<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>