Sophie

Sophie

distrib > Mageia > 6 > i586 > media > core-release > by-pkgid > dcba08025f2814910ab603731a9c888d > files > 274

libe-book-doc-0.1.2-10.mga6.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>libebook::EBOOKBitStream Class Reference documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classlibebook_1_1EBOOKBitStream.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#pri-static-attribs">Static Private Attributes</a> &#124;
<a href="classlibebook_1_1EBOOKBitStream-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">libebook::EBOOKBitStream Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="EBOOKBitStream_8h_source.html">EBOOKBitStream.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af73daeb8192ac61030df73746f01ad0c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1EBOOKBitStream.html#af73daeb8192ac61030df73746f01ad0c">EBOOKBitStream</a> (librevenge::RVNGInputStream *<a class="el" href="CHMStream_8cpp.html#a304256d75bcb5359034686d252689be1">stream</a>)</td></tr>
<tr class="separator:af73daeb8192ac61030df73746f01ad0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b1acc02fce057c2b159e66574489962"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1EBOOKBitStream.html#a1b1acc02fce057c2b159e66574489962">read</a> (uint8_t numberOfBits, bool bigEndian=false)</td></tr>
<tr class="separator:a1b1acc02fce057c2b159e66574489962"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38dd1772974ef8142cc320f5636ddb08"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1EBOOKBitStream.html#a38dd1772974ef8142cc320f5636ddb08">isEnd</a> () const</td></tr>
<tr class="separator:a38dd1772974ef8142cc320f5636ddb08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af46fd39d4f414d403dc3b57590b7638c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1EBOOKBitStream.html#af46fd39d4f414d403dc3b57590b7638c">atLastByte</a> () const</td></tr>
<tr class="separator:af46fd39d4f414d403dc3b57590b7638c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a3a9bf0ed5edefd841a3d864020928bee"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1EBOOKBitStream.html#a3a9bf0ed5edefd841a3d864020928bee">fill</a> ()</td></tr>
<tr class="separator:a3a9bf0ed5edefd841a3d864020928bee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97496142b703061d6eaf401b666e56f3"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1EBOOKBitStream.html#a97496142b703061d6eaf401b666e56f3">readByte</a> ()</td></tr>
<tr class="memdesc:a97496142b703061d6eaf401b666e56f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads a byte from the stream.  <a href="#a97496142b703061d6eaf401b666e56f3">More...</a><br /></td></tr>
<tr class="separator:a97496142b703061d6eaf401b666e56f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac15bad03f5b4eb51db5073a22cf00b0f"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1EBOOKBitStream.html#ac15bad03f5b4eb51db5073a22cf00b0f">readBits</a> (uint8_t numberOfBits)</td></tr>
<tr class="memdesc:ac15bad03f5b4eb51db5073a22cf00b0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads a given amount of bits from the stream.  <a href="#ac15bad03f5b4eb51db5073a22cf00b0f">More...</a><br /></td></tr>
<tr class="separator:ac15bad03f5b4eb51db5073a22cf00b0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf0ef346d5d733768813087059dfeb2e"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1EBOOKBitStream.html#aaf0ef346d5d733768813087059dfeb2e">readAvailableBits</a> (uint8_t numberOfBits)</td></tr>
<tr class="separator:aaf0ef346d5d733768813087059dfeb2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a65934e2a6528cd75480512bc9545fa8a"><td class="memItemLeft" align="right" valign="top">librevenge::RVNGInputStream *const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1EBOOKBitStream.html#a65934e2a6528cd75480512bc9545fa8a">m_stream</a></td></tr>
<tr class="separator:a65934e2a6528cd75480512bc9545fa8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afff7c90347be65e3a93d4d7ebb2d59b0"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1EBOOKBitStream.html#afff7c90347be65e3a93d4d7ebb2d59b0">m_current</a></td></tr>
<tr class="separator:afff7c90347be65e3a93d4d7ebb2d59b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc30e6932d53e8d2113327ac85def29b"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1EBOOKBitStream.html#adc30e6932d53e8d2113327ac85def29b">m_available</a></td></tr>
<tr class="separator:adc30e6932d53e8d2113327ac85def29b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr class="memitem:a7a76bcad126718d736262ab46950ef3d"><td class="memItemLeft" align="right" valign="top">static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibebook_1_1EBOOKBitStream.html#a7a76bcad126718d736262ab46950ef3d">s_masks</a> [8] = { 0x1, 0x3, 0x7, 0xf, 0x1f, 0x3f, 0x7f, 0xff }</td></tr>
<tr class="separator:a7a76bcad126718d736262ab46950ef3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af73daeb8192ac61030df73746f01ad0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af73daeb8192ac61030df73746f01ad0c">&#9670;&nbsp;</a></span>EBOOKBitStream()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">libebook::EBOOKBitStream::EBOOKBitStream </td>
          <td>(</td>
          <td class="paramtype">librevenge::RVNGInputStream *&#160;</td>
          <td class="paramname"><em>stream</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af46fd39d4f414d403dc3b57590b7638c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af46fd39d4f414d403dc3b57590b7638c">&#9670;&nbsp;</a></span>atLastByte()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool libebook::EBOOKBitStream::atLastByte </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="reference">Referenced by <a class="el" href="classlibebook_1_1EBOOKBitStream.html#a38dd1772974ef8142cc320f5636ddb08">isEnd()</a>.</p>

</div>
</div>
<a id="a3a9bf0ed5edefd841a3d864020928bee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a9bf0ed5edefd841a3d864020928bee">&#9670;&nbsp;</a></span>fill()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void libebook::EBOOKBitStream::fill </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="reference">Referenced by <a class="el" href="classlibebook_1_1EBOOKBitStream.html#af46fd39d4f414d403dc3b57590b7638c">atLastByte()</a>, and <a class="el" href="classlibebook_1_1EBOOKBitStream.html#ac15bad03f5b4eb51db5073a22cf00b0f">readBits()</a>.</p>

</div>
</div>
<a id="a38dd1772974ef8142cc320f5636ddb08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38dd1772974ef8142cc320f5636ddb08">&#9670;&nbsp;</a></span>isEnd()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool libebook::EBOOKBitStream::isEnd </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a1b1acc02fce057c2b159e66574489962"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b1acc02fce057c2b159e66574489962">&#9670;&nbsp;</a></span>read()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t libebook::EBOOKBitStream::read </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>numberOfBits</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>bigEndian</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="aaf0ef346d5d733768813087059dfeb2e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf0ef346d5d733768813087059dfeb2e">&#9670;&nbsp;</a></span>readAvailableBits()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t libebook::EBOOKBitStream::readAvailableBits </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>numberOfBits</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="reference">Referenced by <a class="el" href="classlibebook_1_1EBOOKBitStream.html#ac15bad03f5b4eb51db5073a22cf00b0f">readBits()</a>.</p>

</div>
</div>
<a id="ac15bad03f5b4eb51db5073a22cf00b0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac15bad03f5b4eb51db5073a22cf00b0f">&#9670;&nbsp;</a></span>readBits()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t libebook::EBOOKBitStream::readBits </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>numberOfBits</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Reads a given amount of bits from the stream. </p>
<ul>
<li>[in] numberOfBits the number of bits to read. Has to be less than or equal to 8.</li>
</ul>
<dl class="section return"><dt>Returns</dt><dd>a byte containing the bits </dd></dl>

<p class="reference">Referenced by <a class="el" href="classlibebook_1_1EBOOKBitStream.html#a1b1acc02fce057c2b159e66574489962">read()</a>, and <a class="el" href="classlibebook_1_1EBOOKBitStream.html#a97496142b703061d6eaf401b666e56f3">readByte()</a>.</p>

</div>
</div>
<a id="a97496142b703061d6eaf401b666e56f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97496142b703061d6eaf401b666e56f3">&#9670;&nbsp;</a></span>readByte()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t libebook::EBOOKBitStream::readByte </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Reads a byte from the stream. </p>
<dl class="section return"><dt>Returns</dt><dd>a byte </dd></dl>

<p class="reference">Referenced by <a class="el" href="classlibebook_1_1EBOOKBitStream.html#a1b1acc02fce057c2b159e66574489962">read()</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="adc30e6932d53e8d2113327ac85def29b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc30e6932d53e8d2113327ac85def29b">&#9670;&nbsp;</a></span>m_available</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t libebook::EBOOKBitStream::m_available</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="reference">Referenced by <a class="el" href="classlibebook_1_1EBOOKBitStream.html#a3a9bf0ed5edefd841a3d864020928bee">fill()</a>, <a class="el" href="classlibebook_1_1EBOOKBitStream.html#a38dd1772974ef8142cc320f5636ddb08">isEnd()</a>, <a class="el" href="classlibebook_1_1EBOOKBitStream.html#aaf0ef346d5d733768813087059dfeb2e">readAvailableBits()</a>, and <a class="el" href="classlibebook_1_1EBOOKBitStream.html#ac15bad03f5b4eb51db5073a22cf00b0f">readBits()</a>.</p>

</div>
</div>
<a id="afff7c90347be65e3a93d4d7ebb2d59b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afff7c90347be65e3a93d4d7ebb2d59b0">&#9670;&nbsp;</a></span>m_current</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t libebook::EBOOKBitStream::m_current</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="reference">Referenced by <a class="el" href="classlibebook_1_1EBOOKBitStream.html#a3a9bf0ed5edefd841a3d864020928bee">fill()</a>, and <a class="el" href="classlibebook_1_1EBOOKBitStream.html#aaf0ef346d5d733768813087059dfeb2e">readAvailableBits()</a>.</p>

</div>
</div>
<a id="a65934e2a6528cd75480512bc9545fa8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65934e2a6528cd75480512bc9545fa8a">&#9670;&nbsp;</a></span>m_stream</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">librevenge::RVNGInputStream* const libebook::EBOOKBitStream::m_stream</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="reference">Referenced by <a class="el" href="classlibebook_1_1EBOOKBitStream.html#af46fd39d4f414d403dc3b57590b7638c">atLastByte()</a>, and <a class="el" href="classlibebook_1_1EBOOKBitStream.html#a3a9bf0ed5edefd841a3d864020928bee">fill()</a>.</p>

</div>
</div>
<a id="a7a76bcad126718d736262ab46950ef3d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a76bcad126718d736262ab46950ef3d">&#9670;&nbsp;</a></span>s_masks</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const uint8_t libebook::EBOOKBitStream::s_masks = { 0x1, 0x3, 0x7, 0xf, 0x1f, 0x3f, 0x7f, 0xff }</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="reference">Referenced by <a class="el" href="classlibebook_1_1EBOOKBitStream.html#aaf0ef346d5d733768813087059dfeb2e">readAvailableBits()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="EBOOKBitStream_8h_source.html">EBOOKBitStream.h</a></li>
<li><a class="el" href="EBOOKBitStream_8cpp.html">EBOOKBitStream.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<hr size="1"><address style="align: right;"><small>
Generated for libe-book by <a href="http://www.doxygen.org/index.html">
doxygen</a> 1.8.13</small></address>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional