classboost_1_1gil_1_1detail_1_1file__stream__device.html 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387
  1. <!-- HTML header for doxygen 1.8.13-->
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  6. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  7. <meta name="generator" content="Doxygen 1.8.15"/>
  8. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  9. <title>Generic Image Library: file_stream_device&lt; FormatTag &gt; Class Template Reference</title>
  10. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11. <script type="text/javascript" src="jquery.js"></script>
  12. <script type="text/javascript" src="dynsections.js"></script>
  13. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  14. <link href="doxygen-boost.css" rel="stylesheet" type="text/css"/>
  15. </head>
  16. <body>
  17. <div class="boost-header">
  18. <table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
  19. <tr>
  20. <td valign="top" width="300">
  21. <h3><a href="../index.html"><img alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
  22. </td>
  23. <td ><h1 align="center"><a href="../index.html"></a></h1></td>
  24. <td></td>
  25. </tr>
  26. </table>
  27. </div>
  28. <hr/>
  29. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  30. <!-- Generated by Doxygen 1.8.15 -->
  31. <script type="text/javascript" src="menudata.js"></script>
  32. <script type="text/javascript" src="menu.js"></script>
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. $(function() {
  36. initMenu('',false,false,'search.php','Search');
  37. });
  38. /* @license-end */</script>
  39. <div id="main-nav"></div>
  40. <div id="nav-path" class="navpath">
  41. <ul>
  42. <li class="navelem"><b>boost</b></li><li class="navelem"><b>gil</b></li><li class="navelem"><b>detail</b></li><li class="navelem"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html">file_stream_device</a></li> </ul>
  43. </div>
  44. </div><!-- top -->
  45. <div class="header">
  46. <div class="summary">
  47. <a href="#nested-classes">Classes</a> &#124;
  48. <a href="#pub-types">Public Types</a> &#124;
  49. <a href="#pub-methods">Public Member Functions</a> &#124;
  50. <a href="classboost_1_1gil_1_1detail_1_1file__stream__device-members.html">List of all members</a> </div>
  51. <div class="headertitle">
  52. <div class="title">file_stream_device&lt; FormatTag &gt; Class Template Reference</div> </div>
  53. </div><!--header-->
  54. <div class="contents">
  55. <p><code>#include &lt;<a class="el" href="device_8hpp_source.html">device.hpp</a>&gt;</code></p>
  56. <table class="memberdecls">
  57. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  58. Classes</h2></td></tr>
  59. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1detail_1_1file__stream__device_1_1read__tag.html">read_tag</a></td></tr>
  60. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used to overload the constructor. <a href="structboost_1_1gil_1_1detail_1_1file__stream__device_1_1read__tag.html#details">More...</a><br /></td></tr>
  61. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. </table><table class="memberdecls">
  63. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  64. Public Types</h2></td></tr>
  65. <tr class="memitem:a9715dd4a4433f2756a85c89b8d7e0965"><td class="memItemLeft" align="right" valign="top"><a id="a9715dd4a4433f2756a85c89b8d7e0965"></a>
  66. using&#160;</td><td class="memItemRight" valign="bottom"><b>format_tag_t</b> = FormatTag</td></tr>
  67. <tr class="separator:a9715dd4a4433f2756a85c89b8d7e0965"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. </table><table class="memberdecls">
  69. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  70. Public Member Functions</h2></td></tr>
  71. <tr class="memitem:a1f2f702329345cf39fae19cdc2158640"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html#a1f2f702329345cf39fae19cdc2158640">file_stream_device</a> (const std::string &amp;file_name, <a class="el" href="structboost_1_1gil_1_1detail_1_1file__stream__device_1_1read__tag.html">read_tag</a> tag=<a class="el" href="structboost_1_1gil_1_1detail_1_1file__stream__device_1_1read__tag.html">read_tag</a>())</td></tr>
  72. <tr class="separator:a1f2f702329345cf39fae19cdc2158640"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:ad692a035bb74a9641b3823eefb3d4f5b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html#ad692a035bb74a9641b3823eefb3d4f5b">file_stream_device</a> (const char *file_name, <a class="el" href="structboost_1_1gil_1_1detail_1_1file__stream__device_1_1read__tag.html">read_tag</a>=<a class="el" href="structboost_1_1gil_1_1detail_1_1file__stream__device_1_1read__tag.html">read_tag</a>())</td></tr>
  74. <tr class="separator:ad692a035bb74a9641b3823eefb3d4f5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:aa2de99e067a8bec7ce7935a23bd9cff7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html#aa2de99e067a8bec7ce7935a23bd9cff7">file_stream_device</a> (const std::string &amp;file_name, write_tag tag)</td></tr>
  76. <tr class="separator:aa2de99e067a8bec7ce7935a23bd9cff7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:a8325e5d8c4cc292297a2febdf2f26f03"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html#a8325e5d8c4cc292297a2febdf2f26f03">file_stream_device</a> (const char *file_name, write_tag)</td></tr>
  78. <tr class="separator:a8325e5d8c4cc292297a2febdf2f26f03"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:a671d48aa2f59b72c610e5675cd393b5a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html#a671d48aa2f59b72c610e5675cd393b5a">file_stream_device</a> (FILE *file)</td></tr>
  80. <tr class="separator:a671d48aa2f59b72c610e5675cd393b5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:aa1c9e61c2d863c63ca5fefd30b246af6"><td class="memItemLeft" align="right" valign="top"><a id="aa1c9e61c2d863c63ca5fefd30b246af6"></a>
  82. FILE *&#160;</td><td class="memItemRight" valign="bottom"><b>get</b> ()</td></tr>
  83. <tr class="separator:aa1c9e61c2d863c63ca5fefd30b246af6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:ade093a8eeac0585f3edf469b97779cc2"><td class="memItemLeft" align="right" valign="top"><a id="ade093a8eeac0585f3edf469b97779cc2"></a>
  85. const FILE *&#160;</td><td class="memItemRight" valign="bottom"><b>get</b> () const</td></tr>
  86. <tr class="separator:ade093a8eeac0585f3edf469b97779cc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a8894f56c82ce2c459b58c0dee2a08567"><td class="memItemLeft" align="right" valign="top"><a id="a8894f56c82ce2c459b58c0dee2a08567"></a>
  88. int&#160;</td><td class="memItemRight" valign="bottom"><b>getc_unchecked</b> ()</td></tr>
  89. <tr class="separator:a8894f56c82ce2c459b58c0dee2a08567"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a4b3c18f6d5eb9485ec3f2b358439c129"><td class="memItemLeft" align="right" valign="top"><a id="a4b3c18f6d5eb9485ec3f2b358439c129"></a>
  91. char&#160;</td><td class="memItemRight" valign="bottom"><b>getc</b> ()</td></tr>
  92. <tr class="separator:a4b3c18f6d5eb9485ec3f2b358439c129"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:ab24d2614f1eb54a5571eccf3a92460ce"><td class="memItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html#ab24d2614f1eb54a5571eccf3a92460ce">read</a> (byte_t *data, std::size_t count)</td></tr>
  94. <tr class="separator:ab24d2614f1eb54a5571eccf3a92460ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a5f0e7e3c2e2d9cc1e728af655a0a4ebd"><td class="memTemplParams" colspan="2"><a id="a5f0e7e3c2e2d9cc1e728af655a0a4ebd"></a>
  96. template&lt;typename T , int N&gt; </td></tr>
  97. <tr class="memitem:a5f0e7e3c2e2d9cc1e728af655a0a4ebd"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html#a5f0e7e3c2e2d9cc1e728af655a0a4ebd">read</a> (T(&amp;buf)[N])</td></tr>
  98. <tr class="memdesc:a5f0e7e3c2e2d9cc1e728af655a0a4ebd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads array. <br /></td></tr>
  99. <tr class="separator:a5f0e7e3c2e2d9cc1e728af655a0a4ebd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a817ffb3a794dffd86f4a7a99cb9a2a4a"><td class="memItemLeft" align="right" valign="top"><a id="a817ffb3a794dffd86f4a7a99cb9a2a4a"></a>
  101. uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html#a817ffb3a794dffd86f4a7a99cb9a2a4a">read_uint8</a> ()</td></tr>
  102. <tr class="memdesc:a817ffb3a794dffd86f4a7a99cb9a2a4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads byte. <br /></td></tr>
  103. <tr class="separator:a817ffb3a794dffd86f4a7a99cb9a2a4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a7d2904b739166f8f094f8194bb04dc43"><td class="memItemLeft" align="right" valign="top"><a id="a7d2904b739166f8f094f8194bb04dc43"></a>
  105. uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html#a7d2904b739166f8f094f8194bb04dc43">read_uint16</a> ()</td></tr>
  106. <tr class="memdesc:a7d2904b739166f8f094f8194bb04dc43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads 16 bit little endian integer. <br /></td></tr>
  107. <tr class="separator:a7d2904b739166f8f094f8194bb04dc43"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:adfad6699e3c78d5ea641e2716b4ad73d"><td class="memItemLeft" align="right" valign="top"><a id="adfad6699e3c78d5ea641e2716b4ad73d"></a>
  109. uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html#adfad6699e3c78d5ea641e2716b4ad73d">read_uint32</a> ()</td></tr>
  110. <tr class="memdesc:adfad6699e3c78d5ea641e2716b4ad73d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads 32 bit little endian integer. <br /></td></tr>
  111. <tr class="separator:adfad6699e3c78d5ea641e2716b4ad73d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a5245d4d6f6409cd6f0b923e5c9ef0b98"><td class="memTemplParams" colspan="2"><a id="a5245d4d6f6409cd6f0b923e5c9ef0b98"></a>
  113. template&lt;typename T &gt; </td></tr>
  114. <tr class="memitem:a5245d4d6f6409cd6f0b923e5c9ef0b98"><td class="memTemplItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html#a5245d4d6f6409cd6f0b923e5c9ef0b98">write</a> (const T *buf, std::size_t count)</td></tr>
  115. <tr class="memdesc:a5245d4d6f6409cd6f0b923e5c9ef0b98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes number of elements from a buffer. <br /></td></tr>
  116. <tr class="separator:a5245d4d6f6409cd6f0b923e5c9ef0b98"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:aab497dd2ae4f798d2649011d0378a26a"><td class="memTemplParams" colspan="2"><a id="aab497dd2ae4f798d2649011d0378a26a"></a>
  118. template&lt;typename T , std::size_t N&gt; </td></tr>
  119. <tr class="memitem:aab497dd2ae4f798d2649011d0378a26a"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html#aab497dd2ae4f798d2649011d0378a26a">write</a> (const T(&amp;buf)[N])</td></tr>
  120. <tr class="memdesc:aab497dd2ae4f798d2649011d0378a26a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes array. <br /></td></tr>
  121. <tr class="separator:aab497dd2ae4f798d2649011d0378a26a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a595ab07d969c1dea44b709fe8a10704f"><td class="memItemLeft" align="right" valign="top"><a id="a595ab07d969c1dea44b709fe8a10704f"></a>
  123. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html#a595ab07d969c1dea44b709fe8a10704f">write_uint8</a> (uint8_t x)</td></tr>
  124. <tr class="memdesc:a595ab07d969c1dea44b709fe8a10704f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes byte. <br /></td></tr>
  125. <tr class="separator:a595ab07d969c1dea44b709fe8a10704f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:ae38d3c677b585360def5ab6ec4bb28b3"><td class="memItemLeft" align="right" valign="top"><a id="ae38d3c677b585360def5ab6ec4bb28b3"></a>
  127. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html#ae38d3c677b585360def5ab6ec4bb28b3">write_uint16</a> (uint16_t x)</td></tr>
  128. <tr class="memdesc:ae38d3c677b585360def5ab6ec4bb28b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes 16 bit little endian integer. <br /></td></tr>
  129. <tr class="separator:ae38d3c677b585360def5ab6ec4bb28b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a2b1f82c9a1f809c77a9d5c83ae7c18bb"><td class="memItemLeft" align="right" valign="top"><a id="a2b1f82c9a1f809c77a9d5c83ae7c18bb"></a>
  131. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html#a2b1f82c9a1f809c77a9d5c83ae7c18bb">write_uint32</a> (uint32_t x)</td></tr>
  132. <tr class="memdesc:a2b1f82c9a1f809c77a9d5c83ae7c18bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes 32 bit little endian integer. <br /></td></tr>
  133. <tr class="separator:a2b1f82c9a1f809c77a9d5c83ae7c18bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a97c3905737bd0578df1a23ed2a00a5a1"><td class="memItemLeft" align="right" valign="top"><a id="a97c3905737bd0578df1a23ed2a00a5a1"></a>
  135. void&#160;</td><td class="memItemRight" valign="bottom"><b>seek</b> (long count, int whence=SEEK_SET)</td></tr>
  136. <tr class="separator:a97c3905737bd0578df1a23ed2a00a5a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a2b4944d2b690c897d9d70e1114a190ca"><td class="memItemLeft" align="right" valign="top"><a id="a2b4944d2b690c897d9d70e1114a190ca"></a>
  138. long int&#160;</td><td class="memItemRight" valign="bottom"><b>tell</b> ()</td></tr>
  139. <tr class="separator:a2b4944d2b690c897d9d70e1114a190ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:adac116554b543b7c4228c018a85882f5"><td class="memItemLeft" align="right" valign="top"><a id="adac116554b543b7c4228c018a85882f5"></a>
  141. void&#160;</td><td class="memItemRight" valign="bottom"><b>flush</b> ()</td></tr>
  142. <tr class="separator:adac116554b543b7c4228c018a85882f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a5117c47dfac83525967e6c01c3b27894"><td class="memItemLeft" align="right" valign="top"><a id="a5117c47dfac83525967e6c01c3b27894"></a>
  144. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html#a5117c47dfac83525967e6c01c3b27894">print_line</a> (const std::string &amp;line)</td></tr>
  145. <tr class="memdesc:a5117c47dfac83525967e6c01c3b27894"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints formatted ASCII text. <br /></td></tr>
  146. <tr class="separator:a5117c47dfac83525967e6c01c3b27894"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:ad1a5ba420409525ff5ab1be86ac5e526"><td class="memItemLeft" align="right" valign="top"><a id="ad1a5ba420409525ff5ab1be86ac5e526"></a>
  148. int&#160;</td><td class="memItemRight" valign="bottom"><b>error</b> ()</td></tr>
  149. <tr class="separator:ad1a5ba420409525ff5ab1be86ac5e526"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. </table>
  151. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  152. <div class="textblock"><h3>template&lt;typename FormatTag&gt;<br />
  153. class boost::gil::detail::file_stream_device&lt; FormatTag &gt;</h3>
  154. <p>Implements the IODevice concept c.f. to <a class="el" href="iobackend.html#IODevice">Concept of IO Device</a> required by Image libraries like libjpeg and libpng.</p>
  155. <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000008">Todo:</a></b></dt><dd>switch to a sane interface as soon as there is something good in boost. I.E. the IOChains library would fit very well here.</dd></dl>
  156. <p>This implementation is based on FILE*. </p>
  157. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  158. <a id="a1f2f702329345cf39fae19cdc2158640"></a>
  159. <h2 class="memtitle"><span class="permalink"><a href="#a1f2f702329345cf39fae19cdc2158640">&#9670;&nbsp;</a></span>file_stream_device() <span class="overload">[1/5]</span></h2>
  160. <div class="memitem">
  161. <div class="memproto">
  162. <table class="mlabels">
  163. <tr>
  164. <td class="mlabels-left">
  165. <table class="memname">
  166. <tr>
  167. <td class="memname"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html">file_stream_device</a> </td>
  168. <td>(</td>
  169. <td class="paramtype">const std::string &amp;&#160;</td>
  170. <td class="paramname"><em>file_name</em>, </td>
  171. </tr>
  172. <tr>
  173. <td class="paramkey"></td>
  174. <td></td>
  175. <td class="paramtype"><a class="el" href="structboost_1_1gil_1_1detail_1_1file__stream__device_1_1read__tag.html">read_tag</a>&#160;</td>
  176. <td class="paramname"><em>tag</em> = <code><a class="el" href="structboost_1_1gil_1_1detail_1_1file__stream__device_1_1read__tag.html">read_tag</a>()</code>&#160;</td>
  177. </tr>
  178. <tr>
  179. <td></td>
  180. <td>)</td>
  181. <td></td><td></td>
  182. </tr>
  183. </table>
  184. </td>
  185. <td class="mlabels-right">
  186. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  187. </tr>
  188. </table>
  189. </div><div class="memdoc">
  190. <p>Constructor </p>
  191. </div>
  192. </div>
  193. <a id="ad692a035bb74a9641b3823eefb3d4f5b"></a>
  194. <h2 class="memtitle"><span class="permalink"><a href="#ad692a035bb74a9641b3823eefb3d4f5b">&#9670;&nbsp;</a></span>file_stream_device() <span class="overload">[2/5]</span></h2>
  195. <div class="memitem">
  196. <div class="memproto">
  197. <table class="mlabels">
  198. <tr>
  199. <td class="mlabels-left">
  200. <table class="memname">
  201. <tr>
  202. <td class="memname"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html">file_stream_device</a> </td>
  203. <td>(</td>
  204. <td class="paramtype">const char *&#160;</td>
  205. <td class="paramname"><em>file_name</em>, </td>
  206. </tr>
  207. <tr>
  208. <td class="paramkey"></td>
  209. <td></td>
  210. <td class="paramtype"><a class="el" href="structboost_1_1gil_1_1detail_1_1file__stream__device_1_1read__tag.html">read_tag</a>&#160;</td>
  211. <td class="paramname"> = <code><a class="el" href="structboost_1_1gil_1_1detail_1_1file__stream__device_1_1read__tag.html">read_tag</a>()</code>&#160;</td>
  212. </tr>
  213. <tr>
  214. <td></td>
  215. <td>)</td>
  216. <td></td><td></td>
  217. </tr>
  218. </table>
  219. </td>
  220. <td class="mlabels-right">
  221. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  222. </tr>
  223. </table>
  224. </div><div class="memdoc">
  225. <p>Constructor </p>
  226. </div>
  227. </div>
  228. <a id="aa2de99e067a8bec7ce7935a23bd9cff7"></a>
  229. <h2 class="memtitle"><span class="permalink"><a href="#aa2de99e067a8bec7ce7935a23bd9cff7">&#9670;&nbsp;</a></span>file_stream_device() <span class="overload">[3/5]</span></h2>
  230. <div class="memitem">
  231. <div class="memproto">
  232. <table class="mlabels">
  233. <tr>
  234. <td class="mlabels-left">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html">file_stream_device</a> </td>
  238. <td>(</td>
  239. <td class="paramtype">const std::string &amp;&#160;</td>
  240. <td class="paramname"><em>file_name</em>, </td>
  241. </tr>
  242. <tr>
  243. <td class="paramkey"></td>
  244. <td></td>
  245. <td class="paramtype">write_tag&#160;</td>
  246. <td class="paramname"><em>tag</em>&#160;</td>
  247. </tr>
  248. <tr>
  249. <td></td>
  250. <td>)</td>
  251. <td></td><td></td>
  252. </tr>
  253. </table>
  254. </td>
  255. <td class="mlabels-right">
  256. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  257. </tr>
  258. </table>
  259. </div><div class="memdoc">
  260. <p>Constructor </p>
  261. </div>
  262. </div>
  263. <a id="a8325e5d8c4cc292297a2febdf2f26f03"></a>
  264. <h2 class="memtitle"><span class="permalink"><a href="#a8325e5d8c4cc292297a2febdf2f26f03">&#9670;&nbsp;</a></span>file_stream_device() <span class="overload">[4/5]</span></h2>
  265. <div class="memitem">
  266. <div class="memproto">
  267. <table class="mlabels">
  268. <tr>
  269. <td class="mlabels-left">
  270. <table class="memname">
  271. <tr>
  272. <td class="memname"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html">file_stream_device</a> </td>
  273. <td>(</td>
  274. <td class="paramtype">const char *&#160;</td>
  275. <td class="paramname"><em>file_name</em>, </td>
  276. </tr>
  277. <tr>
  278. <td class="paramkey"></td>
  279. <td></td>
  280. <td class="paramtype">write_tag&#160;</td>
  281. <td class="paramname">&#160;</td>
  282. </tr>
  283. <tr>
  284. <td></td>
  285. <td>)</td>
  286. <td></td><td></td>
  287. </tr>
  288. </table>
  289. </td>
  290. <td class="mlabels-right">
  291. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  292. </tr>
  293. </table>
  294. </div><div class="memdoc">
  295. <p>Constructor </p>
  296. </div>
  297. </div>
  298. <a id="a671d48aa2f59b72c610e5675cd393b5a"></a>
  299. <h2 class="memtitle"><span class="permalink"><a href="#a671d48aa2f59b72c610e5675cd393b5a">&#9670;&nbsp;</a></span>file_stream_device() <span class="overload">[5/5]</span></h2>
  300. <div class="memitem">
  301. <div class="memproto">
  302. <table class="mlabels">
  303. <tr>
  304. <td class="mlabels-left">
  305. <table class="memname">
  306. <tr>
  307. <td class="memname"><a class="el" href="classboost_1_1gil_1_1detail_1_1file__stream__device.html">file_stream_device</a> </td>
  308. <td>(</td>
  309. <td class="paramtype">FILE *&#160;</td>
  310. <td class="paramname"><em>file</em></td><td>)</td>
  311. <td></td>
  312. </tr>
  313. </table>
  314. </td>
  315. <td class="mlabels-right">
  316. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. <p>Constructor </p>
  321. </div>
  322. </div>
  323. <h2 class="groupheader">Member Function Documentation</h2>
  324. <a id="ab24d2614f1eb54a5571eccf3a92460ce"></a>
  325. <h2 class="memtitle"><span class="permalink"><a href="#ab24d2614f1eb54a5571eccf3a92460ce">&#9670;&nbsp;</a></span>read()</h2>
  326. <div class="memitem">
  327. <div class="memproto">
  328. <table class="mlabels">
  329. <tr>
  330. <td class="mlabels-left">
  331. <table class="memname">
  332. <tr>
  333. <td class="memname">std::size_t read </td>
  334. <td>(</td>
  335. <td class="paramtype">byte_t *&#160;</td>
  336. <td class="paramname"><em>data</em>, </td>
  337. </tr>
  338. <tr>
  339. <td class="paramkey"></td>
  340. <td></td>
  341. <td class="paramtype">std::size_t&#160;</td>
  342. <td class="paramname"><em>count</em>&#160;</td>
  343. </tr>
  344. <tr>
  345. <td></td>
  346. <td>)</td>
  347. <td></td><td></td>
  348. </tr>
  349. </table>
  350. </td>
  351. <td class="mlabels-right">
  352. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  353. </tr>
  354. </table>
  355. </div><div class="memdoc">
  356. <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000009">Todo:</a></b></dt><dd>: change byte_t* to void* </dd></dl>
  357. <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000010">Todo:</a></b></dt><dd>: add compiler symbol to turn error checking on and off. </dd></dl>
  358. </div>
  359. </div>
  360. <hr/>The documentation for this class was generated from the following file:<ul>
  361. <li><a class="el" href="device_8hpp_source.html">device.hpp</a></li>
  362. </ul>
  363. </div><!-- contents -->
  364. <!-- HTML footer for doxygen 1.8.13-->
  365. <!-- start footer part -->
  366. <hr class="footer"/>
  367. <address class="footer">
  368. <small>
  369. Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
  370. </small>
  371. </address>
  372. </body>
  373. </html>