blob: 013a9add3d2670c089590ec35ef7847d157ec1b1 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title> TemplateBufFragGroup&lt; ChainClass, max_frags &gt; class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
<hr><h1>BufFragGroup&lt; ChainClass, max_frags &gt; Class Template Reference<br>
<small>
[<a class="el" href="group__osclutil.html">OSCL Util</a>]</small>
</h1><code>#include &lt;<a class="el" href="oscl__media__data_8h-source.html">oscl_media_data.h</a>&gt;</code>
<p>
<p>Inheritance diagram for BufFragGroup&lt; ChainClass, max_frags &gt;:
<p><center><img src="classBufFragGroup.png" usemap="#BufFragGroup< ChainClass, max_frags >_map" border="0" alt=""></center>
<map name="BufFragGroup< ChainClass, max_frags >_map">
<area href="classMediaData.html" alt="MediaData< ChainClass, max_frags, local_bufsize >" shape="rect" coords="0,56,311,80">
</map>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classBufFragGroup.html#a0">BufFragGroup</a> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classBufFragGroup.html#a1">~BufFragGroup</a> ()</td></tr>
<tr><td nowrap align=right valign=top>int32&nbsp;</td><td valign=bottom><a class="el" href="classBufFragGroup.html#a2">GetMaxFrags</a> () const</td></tr>
<tr><td nowrap align=right valign=top>int32&nbsp;</td><td valign=bottom><a class="el" href="classBufFragGroup.html#a3">GetNumFrags</a> () const</td></tr>
<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classBufFragGroup.html#a4">GetLength</a> () const</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classBufferFragment.html">BufferFragment</a> *&nbsp;</td><td valign=bottom><a class="el" href="group__osclutil.html#a48">GetFragment</a> (const int32 idx)</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classBufferState.html">BufferState</a> *&nbsp;</td><td valign=bottom><a class="el" href="group__osclutil.html#a49">GetBufferState</a> (const int32 idx)</td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classBufFragGroup.html#a7">AppendNext</a> (ChainClass *next_ptr)</td></tr>
<tr><td nowrap align=right valign=top>ChainClass *&nbsp;</td><td valign=bottom><a class="el" href="classBufFragGroup.html#a8">GetNext</a> () const</td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classBufFragGroup.html#b0">Clear</a> ()</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classBufFragStatusClass.html#s8">BufFragStatusClass::status_t</a>&nbsp;</td><td valign=bottom><a class="el" href="classBufFragGroup.html#b1">AddFragment</a> (const <a class="el" href="classBufferFragment.html">BufferFragment</a> &amp;frag, <a class="el" href="classBufferState.html">BufferState</a> *in_buffer_state, int32 location_offset=max_frags)</td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classBufferFragment.html">BufferFragment</a>&nbsp;</td><td valign=bottom><a class="el" href="classBufFragGroup.html#n0">fragments</a> [max_frags]</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classBufferState.html">BufferState</a> *&nbsp;</td><td valign=bottom><a class="el" href="classBufFragGroup.html#n1">buffer_states</a> [max_frags]</td></tr>
<tr><td nowrap align=right valign=top>ChainClass *&nbsp;</td><td valign=bottom><a class="el" href="classBufFragGroup.html#n2">next</a></td></tr>
<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classBufFragGroup.html#n3">num_fragments</a></td></tr>
<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classBufFragGroup.html#n4">length</a></td></tr>
</table>
<h3>template&lt;class ChainClass, uint32 max_frags&gt;<br>
class BufFragGroup&lt; ChainClass, max_frags &gt;</h3>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="BufFragGroup::BufFragGroup"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> BufFragGroup&lt; ChainClass, max_frags &gt;::BufFragGroup </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a1" doxytag="BufFragGroup::~BufFragGroup"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> virtual BufFragGroup&lt; ChainClass, max_frags &gt;::~BufFragGroup </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="b1" doxytag="BufFragGroup::AddFragment"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classBufFragStatusClass.html#s8">BufFragStatusClass::status_t</a> BufFragGroup&lt; ChainClass, max_frags &gt;::AddFragment </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classBufferFragment.html">BufferFragment</a> &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>frag</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="classBufferState.html">BufferState</a> *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>in_buffer_state</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int32&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>location_offset</em> = max_frags</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a7" doxytag="BufFragGroup::AppendNext"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> void BufFragGroup&lt; ChainClass, max_frags &gt;::AppendNext </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">ChainClass *&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>next_ptr</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="b0" doxytag="BufFragGroup::Clear"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> virtual void BufFragGroup&lt; ChainClass, max_frags &gt;::Clear </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<p>
Reimplemented in <a class="el" href="classMediaData.html#a7">MediaData&lt; ChainClass, max_frags, local_bufsize &gt;</a>. </td>
</tr>
</table>
<a name="a4" doxytag="BufFragGroup::GetLength"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> uint32 BufFragGroup&lt; ChainClass, max_frags &gt;::GetLength </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a2" doxytag="BufFragGroup::GetMaxFrags"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> int32 BufFragGroup&lt; ChainClass, max_frags &gt;::GetMaxFrags </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a8" doxytag="BufFragGroup::GetNext"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> ChainClass* BufFragGroup&lt; ChainClass, max_frags &gt;::GetNext </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a3" doxytag="BufFragGroup::GetNumFrags"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> int32 BufFragGroup&lt; ChainClass, max_frags &gt;::GetNumFrags </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Field Documentation</h2>
<a name="n1" doxytag="BufFragGroup::buffer_states"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classBufferState.html">BufferState</a>* BufFragGroup&lt; ChainClass, max_frags &gt;::buffer_states[max_frags]<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="n0" doxytag="BufFragGroup::fragments"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classBufferFragment.html">BufferFragment</a> BufFragGroup&lt; ChainClass, max_frags &gt;::fragments[max_frags]<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="n4" doxytag="BufFragGroup::length"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> uint32 BufFragGroup&lt; ChainClass, max_frags &gt;::length<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="n2" doxytag="BufFragGroup::next"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> ChainClass* BufFragGroup&lt; ChainClass, max_frags &gt;::next<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="n3" doxytag="BufFragGroup::num_fragments"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template&lt;class ChainClass, uint32 max_frags&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> uint32 BufFragGroup&lt; ChainClass, max_frags &gt;::num_fragments<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="oscl__media__data_8h-source.html">oscl_media_data.h</a></ul>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
</small></address>
</body>
</html>