You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

886 lines
38KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.16"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>SdFat: BufferedPrint&lt; WriteClass, BUF_DIM &gt; Class Template Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">SdFat
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.8.16 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Public Member Functions</a> &#124;
  64. <a href="class_buffered_print-members.html">List of all members</a> </div>
  65. <div class="headertitle">
  66. <div class="title">BufferedPrint&lt; WriteClass, BUF_DIM &gt; Class Template Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>Fast buffered print template.
  70. <a href="class_buffered_print.html#details">More...</a></p>
  71. <p><code>#include &lt;BufferedPrint.h&gt;</code></p>
  72. <table class="memberdecls">
  73. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  74. Public Member Functions</h2></td></tr>
  75. <tr class="memitem:a1382e2cedf67d12aa3ba056b0e7b10d3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffered_print.html#a1382e2cedf67d12aa3ba056b0e7b10d3">begin</a> (WriteClass *wr)</td></tr>
  76. <tr class="separator:a1382e2cedf67d12aa3ba056b0e7b10d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:af879eab3e69cfd9d15768451e091c6a2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffered_print.html#af879eab3e69cfd9d15768451e091c6a2">BufferedPrint</a> (WriteClass *wr)</td></tr>
  78. <tr class="separator:af879eab3e69cfd9d15768451e091c6a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:a3fcb4970129a6fbfbd125ed8f2869d9b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffered_print.html#a3fcb4970129a6fbfbd125ed8f2869d9b">flush</a> ()</td></tr>
  80. <tr class="separator:a3fcb4970129a6fbfbd125ed8f2869d9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a95f984c4702b0e20d781efd9d1ea8f27"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffered_print.html#a95f984c4702b0e20d781efd9d1ea8f27">print</a> (double d, uint8_t prec=2)</td></tr>
  82. <tr class="separator:a95f984c4702b0e20d781efd9d1ea8f27"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:aeed86ef2ea320cd8ff47ee871663a8ce"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffered_print.html#aeed86ef2ea320cd8ff47ee871663a8ce">print</a> (float f, uint8_t prec=2)</td></tr>
  84. <tr class="separator:aeed86ef2ea320cd8ff47ee871663a8ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:ae9472f3acd3f7d3187500e60754963bb"><td class="memTemplParams" colspan="2">template&lt;typename Type &gt; </td></tr>
  86. <tr class="memitem:ae9472f3acd3f7d3187500e60754963bb"><td class="memTemplItemLeft" align="right" valign="top">size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_buffered_print.html#ae9472f3acd3f7d3187500e60754963bb">print</a> (Type v)</td></tr>
  87. <tr class="separator:ae9472f3acd3f7d3187500e60754963bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a69ea9541fb854448b9fe3aff44583975"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffered_print.html#a69ea9541fb854448b9fe3aff44583975">printField</a> (char c, char term)</td></tr>
  89. <tr class="separator:a69ea9541fb854448b9fe3aff44583975"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:ac18cc8c86b73b073a28db85075215f4f"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffered_print.html#ac18cc8c86b73b073a28db85075215f4f">printField</a> (const __FlashStringHelper *fsh, char term)</td></tr>
  91. <tr class="separator:ac18cc8c86b73b073a28db85075215f4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:ac49d0beb5fdad68e82f741bbaad4bb1b"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffered_print.html#ac49d0beb5fdad68e82f741bbaad4bb1b">printField</a> (const char *str, char term)</td></tr>
  93. <tr class="separator:ac49d0beb5fdad68e82f741bbaad4bb1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a5b5b11f01adf91a1854a44b131886219"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffered_print.html#a5b5b11f01adf91a1854a44b131886219">printField</a> (double d, char term, uint8_t prec=2)</td></tr>
  95. <tr class="separator:a5b5b11f01adf91a1854a44b131886219"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a93369fc042366488ef40426f9fd3286d"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffered_print.html#a93369fc042366488ef40426f9fd3286d">printField</a> (float f, char term, uint8_t prec=2)</td></tr>
  97. <tr class="separator:a93369fc042366488ef40426f9fd3286d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:af680cf36170347287d20ed92ae5f6c9b"><td class="memTemplParams" colspan="2">template&lt;typename Type &gt; </td></tr>
  99. <tr class="memitem:af680cf36170347287d20ed92ae5f6c9b"><td class="memTemplItemLeft" align="right" valign="top">size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_buffered_print.html#af680cf36170347287d20ed92ae5f6c9b">printField</a> (Type n, char term)</td></tr>
  100. <tr class="separator:af680cf36170347287d20ed92ae5f6c9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a7bd188ccc8b38b83cf44b96164a1d816"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffered_print.html#a7bd188ccc8b38b83cf44b96164a1d816">println</a> ()</td></tr>
  102. <tr class="separator:a7bd188ccc8b38b83cf44b96164a1d816"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:aaeaceb452361377ce73db0041edbcdff"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffered_print.html#aaeaceb452361377ce73db0041edbcdff">println</a> (double d, uint8_t prec=2)</td></tr>
  104. <tr class="separator:aaeaceb452361377ce73db0041edbcdff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:afc449966c5c7357fde925c6888669698"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffered_print.html#afc449966c5c7357fde925c6888669698">println</a> (float f, uint8_t prec)</td></tr>
  106. <tr class="separator:afc449966c5c7357fde925c6888669698"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a0945ed373bd17a309bb6661faad3be9c"><td class="memTemplParams" colspan="2">template&lt;typename Type &gt; </td></tr>
  108. <tr class="memitem:a0945ed373bd17a309bb6661faad3be9c"><td class="memTemplItemLeft" align="right" valign="top">size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_buffered_print.html#a0945ed373bd17a309bb6661faad3be9c">println</a> (Type v)</td></tr>
  109. <tr class="separator:a0945ed373bd17a309bb6661faad3be9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a2253d1e7f231b94b18eab1281c123a49"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffered_print.html#a2253d1e7f231b94b18eab1281c123a49">sync</a> ()</td></tr>
  111. <tr class="separator:a2253d1e7f231b94b18eab1281c123a49"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:ab41de6eca77a04a49a6fc965b1950fc5"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffered_print.html#ab41de6eca77a04a49a6fc965b1950fc5">write</a> (const void *src, size_t n)</td></tr>
  113. <tr class="separator:ab41de6eca77a04a49a6fc965b1950fc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. </table>
  115. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  116. <div class="textblock"><h3>template&lt;typename WriteClass, uint8_t BUF_DIM&gt;<br />
  117. class BufferedPrint&lt; WriteClass, BUF_DIM &gt;</h3>
  118. <p>Fast buffered print template. </p>
  119. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  120. <a id="af879eab3e69cfd9d15768451e091c6a2"></a>
  121. <h2 class="memtitle"><span class="permalink"><a href="#af879eab3e69cfd9d15768451e091c6a2">&#9670;&nbsp;</a></span>BufferedPrint()</h2>
  122. <div class="memitem">
  123. <div class="memproto">
  124. <div class="memtemplate">
  125. template&lt;typename WriteClass , uint8_t BUF_DIM&gt; </div>
  126. <table class="mlabels">
  127. <tr>
  128. <td class="mlabels-left">
  129. <table class="memname">
  130. <tr>
  131. <td class="memname"><a class="el" href="class_buffered_print.html">BufferedPrint</a>&lt; WriteClass, BUF_DIM &gt;::<a class="el" href="class_buffered_print.html">BufferedPrint</a> </td>
  132. <td>(</td>
  133. <td class="paramtype">WriteClass *&#160;</td>
  134. <td class="paramname"><em>wr</em></td><td>)</td>
  135. <td></td>
  136. </tr>
  137. </table>
  138. </td>
  139. <td class="mlabels-right">
  140. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. <p><a class="el" href="class_buffered_print.html" title="Fast buffered print template.">BufferedPrint</a> constructor. </p><dl class="params"><dt>Parameters</dt><dd>
  145. <table class="params">
  146. <tr><td class="paramdir">[in]</td><td class="paramname">wr</td><td>Print destination. </td></tr>
  147. </table>
  148. </dd>
  149. </dl>
  150. </div>
  151. </div>
  152. <h2 class="groupheader">Member Function Documentation</h2>
  153. <a id="a1382e2cedf67d12aa3ba056b0e7b10d3"></a>
  154. <h2 class="memtitle"><span class="permalink"><a href="#a1382e2cedf67d12aa3ba056b0e7b10d3">&#9670;&nbsp;</a></span>begin()</h2>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <div class="memtemplate">
  158. template&lt;typename WriteClass , uint8_t BUF_DIM&gt; </div>
  159. <table class="mlabels">
  160. <tr>
  161. <td class="mlabels-left">
  162. <table class="memname">
  163. <tr>
  164. <td class="memname">void <a class="el" href="class_buffered_print.html">BufferedPrint</a>&lt; WriteClass, BUF_DIM &gt;::begin </td>
  165. <td>(</td>
  166. <td class="paramtype">WriteClass *&#160;</td>
  167. <td class="paramname"><em>wr</em></td><td>)</td>
  168. <td></td>
  169. </tr>
  170. </table>
  171. </td>
  172. <td class="mlabels-right">
  173. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. <p>Initialize the BuffedPrint class. </p><dl class="params"><dt>Parameters</dt><dd>
  178. <table class="params">
  179. <tr><td class="paramdir">[in]</td><td class="paramname">wr</td><td>Print destination. </td></tr>
  180. </table>
  181. </dd>
  182. </dl>
  183. </div>
  184. </div>
  185. <a id="a3fcb4970129a6fbfbd125ed8f2869d9b"></a>
  186. <h2 class="memtitle"><span class="permalink"><a href="#a3fcb4970129a6fbfbd125ed8f2869d9b">&#9670;&nbsp;</a></span>flush()</h2>
  187. <div class="memitem">
  188. <div class="memproto">
  189. <div class="memtemplate">
  190. template&lt;typename WriteClass , uint8_t BUF_DIM&gt; </div>
  191. <table class="mlabels">
  192. <tr>
  193. <td class="mlabels-left">
  194. <table class="memname">
  195. <tr>
  196. <td class="memname">void <a class="el" href="class_buffered_print.html">BufferedPrint</a>&lt; WriteClass, BUF_DIM &gt;::flush </td>
  197. <td>(</td>
  198. <td class="paramname"></td><td>)</td>
  199. <td></td>
  200. </tr>
  201. </table>
  202. </td>
  203. <td class="mlabels-right">
  204. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  205. </tr>
  206. </table>
  207. </div><div class="memdoc">
  208. <p>Flush the buffer - same as <a class="el" href="class_buffered_print.html#a2253d1e7f231b94b18eab1281c123a49">sync()</a> with no status return. </p>
  209. </div>
  210. </div>
  211. <a id="a95f984c4702b0e20d781efd9d1ea8f27"></a>
  212. <h2 class="memtitle"><span class="permalink"><a href="#a95f984c4702b0e20d781efd9d1ea8f27">&#9670;&nbsp;</a></span>print() <span class="overload">[1/3]</span></h2>
  213. <div class="memitem">
  214. <div class="memproto">
  215. <div class="memtemplate">
  216. template&lt;typename WriteClass , uint8_t BUF_DIM&gt; </div>
  217. <table class="mlabels">
  218. <tr>
  219. <td class="mlabels-left">
  220. <table class="memname">
  221. <tr>
  222. <td class="memname">size_t <a class="el" href="class_buffered_print.html">BufferedPrint</a>&lt; WriteClass, BUF_DIM &gt;::print </td>
  223. <td>(</td>
  224. <td class="paramtype">double&#160;</td>
  225. <td class="paramname"><em>d</em>, </td>
  226. </tr>
  227. <tr>
  228. <td class="paramkey"></td>
  229. <td></td>
  230. <td class="paramtype">uint8_t&#160;</td>
  231. <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>
  232. </tr>
  233. <tr>
  234. <td></td>
  235. <td>)</td>
  236. <td></td><td></td>
  237. </tr>
  238. </table>
  239. </td>
  240. <td class="mlabels-right">
  241. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  242. </tr>
  243. </table>
  244. </div><div class="memdoc">
  245. <p>Print a double. </p><dl class="params"><dt>Parameters</dt><dd>
  246. <table class="params">
  247. <tr><td class="paramdir">[in]</td><td class="paramname">d</td><td>The number to be printed. </td></tr>
  248. <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>
  249. </table>
  250. </dd>
  251. </dl>
  252. <dl class="section return"><dt>Returns</dt><dd>true for success or false if an error occurs. </dd></dl>
  253. </div>
  254. </div>
  255. <a id="aeed86ef2ea320cd8ff47ee871663a8ce"></a>
  256. <h2 class="memtitle"><span class="permalink"><a href="#aeed86ef2ea320cd8ff47ee871663a8ce">&#9670;&nbsp;</a></span>print() <span class="overload">[2/3]</span></h2>
  257. <div class="memitem">
  258. <div class="memproto">
  259. <div class="memtemplate">
  260. template&lt;typename WriteClass , uint8_t BUF_DIM&gt; </div>
  261. <table class="mlabels">
  262. <tr>
  263. <td class="mlabels-left">
  264. <table class="memname">
  265. <tr>
  266. <td class="memname">size_t <a class="el" href="class_buffered_print.html">BufferedPrint</a>&lt; WriteClass, BUF_DIM &gt;::print </td>
  267. <td>(</td>
  268. <td class="paramtype">float&#160;</td>
  269. <td class="paramname"><em>f</em>, </td>
  270. </tr>
  271. <tr>
  272. <td class="paramkey"></td>
  273. <td></td>
  274. <td class="paramtype">uint8_t&#160;</td>
  275. <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>
  276. </tr>
  277. <tr>
  278. <td></td>
  279. <td>)</td>
  280. <td></td><td></td>
  281. </tr>
  282. </table>
  283. </td>
  284. <td class="mlabels-right">
  285. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  286. </tr>
  287. </table>
  288. </div><div class="memdoc">
  289. <p>Print a float. </p><dl class="params"><dt>Parameters</dt><dd>
  290. <table class="params">
  291. <tr><td class="paramdir">[in]</td><td class="paramname">f</td><td>The number to be printed. </td></tr>
  292. <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>
  293. </table>
  294. </dd>
  295. </dl>
  296. <dl class="section return"><dt>Returns</dt><dd>true for success or false if an error occurs. </dd></dl>
  297. </div>
  298. </div>
  299. <a id="ae9472f3acd3f7d3187500e60754963bb"></a>
  300. <h2 class="memtitle"><span class="permalink"><a href="#ae9472f3acd3f7d3187500e60754963bb">&#9670;&nbsp;</a></span>print() <span class="overload">[3/3]</span></h2>
  301. <div class="memitem">
  302. <div class="memproto">
  303. <div class="memtemplate">
  304. template&lt;typename WriteClass , uint8_t BUF_DIM&gt; </div>
  305. <div class="memtemplate">
  306. template&lt;typename Type &gt; </div>
  307. <table class="mlabels">
  308. <tr>
  309. <td class="mlabels-left">
  310. <table class="memname">
  311. <tr>
  312. <td class="memname">size_t <a class="el" href="class_buffered_print.html">BufferedPrint</a>&lt; WriteClass, BUF_DIM &gt;::print </td>
  313. <td>(</td>
  314. <td class="paramtype">Type&#160;</td>
  315. <td class="paramname"><em>v</em></td><td>)</td>
  316. <td></td>
  317. </tr>
  318. </table>
  319. </td>
  320. <td class="mlabels-right">
  321. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  322. </tr>
  323. </table>
  324. </div><div class="memdoc">
  325. <p>Print character, string, or number. </p><dl class="params"><dt>Parameters</dt><dd>
  326. <table class="params">
  327. <tr><td class="paramdir">[in]</td><td class="paramname">v</td><td>item to print. </td></tr>
  328. </table>
  329. </dd>
  330. </dl>
  331. <dl class="section return"><dt>Returns</dt><dd>true for success or false if an error occurs. </dd></dl>
  332. </div>
  333. </div>
  334. <a id="a69ea9541fb854448b9fe3aff44583975"></a>
  335. <h2 class="memtitle"><span class="permalink"><a href="#a69ea9541fb854448b9fe3aff44583975">&#9670;&nbsp;</a></span>printField() <span class="overload">[1/6]</span></h2>
  336. <div class="memitem">
  337. <div class="memproto">
  338. <div class="memtemplate">
  339. template&lt;typename WriteClass , uint8_t BUF_DIM&gt; </div>
  340. <table class="mlabels">
  341. <tr>
  342. <td class="mlabels-left">
  343. <table class="memname">
  344. <tr>
  345. <td class="memname">size_t <a class="el" href="class_buffered_print.html">BufferedPrint</a>&lt; WriteClass, BUF_DIM &gt;::printField </td>
  346. <td>(</td>
  347. <td class="paramtype">char&#160;</td>
  348. <td class="paramname"><em>c</em>, </td>
  349. </tr>
  350. <tr>
  351. <td class="paramkey"></td>
  352. <td></td>
  353. <td class="paramtype">char&#160;</td>
  354. <td class="paramname"><em>term</em>&#160;</td>
  355. </tr>
  356. <tr>
  357. <td></td>
  358. <td>)</td>
  359. <td></td><td></td>
  360. </tr>
  361. </table>
  362. </td>
  363. <td class="mlabels-right">
  364. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  365. </tr>
  366. </table>
  367. </div><div class="memdoc">
  368. <p>Print a character followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>
  369. <table class="params">
  370. <tr><td class="paramdir">[in]</td><td class="paramname">c</td><td>character to print. </td></tr>
  371. <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>
  372. </table>
  373. </dd>
  374. </dl>
  375. <dl class="section return"><dt>Returns</dt><dd>true for success or false if an error occurs. </dd></dl>
  376. </div>
  377. </div>
  378. <a id="ac18cc8c86b73b073a28db85075215f4f"></a>
  379. <h2 class="memtitle"><span class="permalink"><a href="#ac18cc8c86b73b073a28db85075215f4f">&#9670;&nbsp;</a></span>printField() <span class="overload">[2/6]</span></h2>
  380. <div class="memitem">
  381. <div class="memproto">
  382. <div class="memtemplate">
  383. template&lt;typename WriteClass , uint8_t BUF_DIM&gt; </div>
  384. <table class="mlabels">
  385. <tr>
  386. <td class="mlabels-left">
  387. <table class="memname">
  388. <tr>
  389. <td class="memname">size_t <a class="el" href="class_buffered_print.html">BufferedPrint</a>&lt; WriteClass, BUF_DIM &gt;::printField </td>
  390. <td>(</td>
  391. <td class="paramtype">const __FlashStringHelper *&#160;</td>
  392. <td class="paramname"><em>fsh</em>, </td>
  393. </tr>
  394. <tr>
  395. <td class="paramkey"></td>
  396. <td></td>
  397. <td class="paramtype">char&#160;</td>
  398. <td class="paramname"><em>term</em>&#160;</td>
  399. </tr>
  400. <tr>
  401. <td></td>
  402. <td>)</td>
  403. <td></td><td></td>
  404. </tr>
  405. </table>
  406. </td>
  407. <td class="mlabels-right">
  408. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  409. </tr>
  410. </table>
  411. </div><div class="memdoc">
  412. <p>Print a string stored in AVR flash followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>
  413. <table class="params">
  414. <tr><td class="paramdir">[in]</td><td class="paramname">fsh</td><td>string to print. </td></tr>
  415. <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>
  416. </table>
  417. </dd>
  418. </dl>
  419. <dl class="section return"><dt>Returns</dt><dd>true for success or false if an error occurs. </dd></dl>
  420. </div>
  421. </div>
  422. <a id="ac49d0beb5fdad68e82f741bbaad4bb1b"></a>
  423. <h2 class="memtitle"><span class="permalink"><a href="#ac49d0beb5fdad68e82f741bbaad4bb1b">&#9670;&nbsp;</a></span>printField() <span class="overload">[3/6]</span></h2>
  424. <div class="memitem">
  425. <div class="memproto">
  426. <div class="memtemplate">
  427. template&lt;typename WriteClass , uint8_t BUF_DIM&gt; </div>
  428. <table class="mlabels">
  429. <tr>
  430. <td class="mlabels-left">
  431. <table class="memname">
  432. <tr>
  433. <td class="memname">size_t <a class="el" href="class_buffered_print.html">BufferedPrint</a>&lt; WriteClass, BUF_DIM &gt;::printField </td>
  434. <td>(</td>
  435. <td class="paramtype">const char *&#160;</td>
  436. <td class="paramname"><em>str</em>, </td>
  437. </tr>
  438. <tr>
  439. <td class="paramkey"></td>
  440. <td></td>
  441. <td class="paramtype">char&#160;</td>
  442. <td class="paramname"><em>term</em>&#160;</td>
  443. </tr>
  444. <tr>
  445. <td></td>
  446. <td>)</td>
  447. <td></td><td></td>
  448. </tr>
  449. </table>
  450. </td>
  451. <td class="mlabels-right">
  452. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  453. </tr>
  454. </table>
  455. </div><div class="memdoc">
  456. <p>Print a string followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>
  457. <table class="params">
  458. <tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>string to print. </td></tr>
  459. <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>
  460. </table>
  461. </dd>
  462. </dl>
  463. <dl class="section return"><dt>Returns</dt><dd>true for success or false if an error occurs. </dd></dl>
  464. </div>
  465. </div>
  466. <a id="a5b5b11f01adf91a1854a44b131886219"></a>
  467. <h2 class="memtitle"><span class="permalink"><a href="#a5b5b11f01adf91a1854a44b131886219">&#9670;&nbsp;</a></span>printField() <span class="overload">[4/6]</span></h2>
  468. <div class="memitem">
  469. <div class="memproto">
  470. <div class="memtemplate">
  471. template&lt;typename WriteClass , uint8_t BUF_DIM&gt; </div>
  472. <table class="mlabels">
  473. <tr>
  474. <td class="mlabels-left">
  475. <table class="memname">
  476. <tr>
  477. <td class="memname">size_t <a class="el" href="class_buffered_print.html">BufferedPrint</a>&lt; WriteClass, BUF_DIM &gt;::printField </td>
  478. <td>(</td>
  479. <td class="paramtype">double&#160;</td>
  480. <td class="paramname"><em>d</em>, </td>
  481. </tr>
  482. <tr>
  483. <td class="paramkey"></td>
  484. <td></td>
  485. <td class="paramtype">char&#160;</td>
  486. <td class="paramname"><em>term</em>, </td>
  487. </tr>
  488. <tr>
  489. <td class="paramkey"></td>
  490. <td></td>
  491. <td class="paramtype">uint8_t&#160;</td>
  492. <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>
  493. </tr>
  494. <tr>
  495. <td></td>
  496. <td>)</td>
  497. <td></td><td></td>
  498. </tr>
  499. </table>
  500. </td>
  501. <td class="mlabels-right">
  502. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  503. </tr>
  504. </table>
  505. </div><div class="memdoc">
  506. <p>Print a double followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>
  507. <table class="params">
  508. <tr><td class="paramdir">[in]</td><td class="paramname">d</td><td>The number to be printed. </td></tr>
  509. <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>
  510. <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>
  511. </table>
  512. </dd>
  513. </dl>
  514. <dl class="section return"><dt>Returns</dt><dd>true for success or false if an error occurs. </dd></dl>
  515. </div>
  516. </div>
  517. <a id="a93369fc042366488ef40426f9fd3286d"></a>
  518. <h2 class="memtitle"><span class="permalink"><a href="#a93369fc042366488ef40426f9fd3286d">&#9670;&nbsp;</a></span>printField() <span class="overload">[5/6]</span></h2>
  519. <div class="memitem">
  520. <div class="memproto">
  521. <div class="memtemplate">
  522. template&lt;typename WriteClass , uint8_t BUF_DIM&gt; </div>
  523. <table class="mlabels">
  524. <tr>
  525. <td class="mlabels-left">
  526. <table class="memname">
  527. <tr>
  528. <td class="memname">size_t <a class="el" href="class_buffered_print.html">BufferedPrint</a>&lt; WriteClass, BUF_DIM &gt;::printField </td>
  529. <td>(</td>
  530. <td class="paramtype">float&#160;</td>
  531. <td class="paramname"><em>f</em>, </td>
  532. </tr>
  533. <tr>
  534. <td class="paramkey"></td>
  535. <td></td>
  536. <td class="paramtype">char&#160;</td>
  537. <td class="paramname"><em>term</em>, </td>
  538. </tr>
  539. <tr>
  540. <td class="paramkey"></td>
  541. <td></td>
  542. <td class="paramtype">uint8_t&#160;</td>
  543. <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>
  544. </tr>
  545. <tr>
  546. <td></td>
  547. <td>)</td>
  548. <td></td><td></td>
  549. </tr>
  550. </table>
  551. </td>
  552. <td class="mlabels-right">
  553. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  554. </tr>
  555. </table>
  556. </div><div class="memdoc">
  557. <p>Print a float followed by a field terminator. </p><dl class="params"><dt>Parameters</dt><dd>
  558. <table class="params">
  559. <tr><td class="paramdir">[in]</td><td class="paramname">f</td><td>The number to be printed. </td></tr>
  560. <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>
  561. <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>
  562. </table>
  563. </dd>
  564. </dl>
  565. <dl class="section return"><dt>Returns</dt><dd>true for success or false if an error occurs. </dd></dl>
  566. </div>
  567. </div>
  568. <a id="af680cf36170347287d20ed92ae5f6c9b"></a>
  569. <h2 class="memtitle"><span class="permalink"><a href="#af680cf36170347287d20ed92ae5f6c9b">&#9670;&nbsp;</a></span>printField() <span class="overload">[6/6]</span></h2>
  570. <div class="memitem">
  571. <div class="memproto">
  572. <div class="memtemplate">
  573. template&lt;typename WriteClass , uint8_t BUF_DIM&gt; </div>
  574. <div class="memtemplate">
  575. template&lt;typename Type &gt; </div>
  576. <table class="mlabels">
  577. <tr>
  578. <td class="mlabels-left">
  579. <table class="memname">
  580. <tr>
  581. <td class="memname">size_t <a class="el" href="class_buffered_print.html">BufferedPrint</a>&lt; WriteClass, BUF_DIM &gt;::printField </td>
  582. <td>(</td>
  583. <td class="paramtype">Type&#160;</td>
  584. <td class="paramname"><em>n</em>, </td>
  585. </tr>
  586. <tr>
  587. <td class="paramkey"></td>
  588. <td></td>
  589. <td class="paramtype">char&#160;</td>
  590. <td class="paramname"><em>term</em>&#160;</td>
  591. </tr>
  592. <tr>
  593. <td></td>
  594. <td>)</td>
  595. <td></td><td></td>
  596. </tr>
  597. </table>
  598. </td>
  599. <td class="mlabels-right">
  600. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  601. </tr>
  602. </table>
  603. </div><div class="memdoc">
  604. <p>Print an integer value for 8, 16, and 32 bit signed and unsigned types. </p><dl class="params"><dt>Parameters</dt><dd>
  605. <table class="params">
  606. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>The value to print. </td></tr>
  607. <tr><td class="paramdir">[in]</td><td class="paramname">term</td><td>The field terminator. Use '\n' for CR LF. </td></tr>
  608. </table>
  609. </dd>
  610. </dl>
  611. <dl class="section return"><dt>Returns</dt><dd>true for success or false if an error occurs. </dd></dl>
  612. </div>
  613. </div>
  614. <a id="a7bd188ccc8b38b83cf44b96164a1d816"></a>
  615. <h2 class="memtitle"><span class="permalink"><a href="#a7bd188ccc8b38b83cf44b96164a1d816">&#9670;&nbsp;</a></span>println() <span class="overload">[1/4]</span></h2>
  616. <div class="memitem">
  617. <div class="memproto">
  618. <div class="memtemplate">
  619. template&lt;typename WriteClass , uint8_t BUF_DIM&gt; </div>
  620. <table class="mlabels">
  621. <tr>
  622. <td class="mlabels-left">
  623. <table class="memname">
  624. <tr>
  625. <td class="memname">size_t <a class="el" href="class_buffered_print.html">BufferedPrint</a>&lt; WriteClass, BUF_DIM &gt;::println </td>
  626. <td>(</td>
  627. <td class="paramname"></td><td>)</td>
  628. <td></td>
  629. </tr>
  630. </table>
  631. </td>
  632. <td class="mlabels-right">
  633. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  634. </tr>
  635. </table>
  636. </div><div class="memdoc">
  637. <p>Print CR LF. </p><dl class="section return"><dt>Returns</dt><dd>true for success or false if an error occurs. </dd></dl>
  638. </div>
  639. </div>
  640. <a id="aaeaceb452361377ce73db0041edbcdff"></a>
  641. <h2 class="memtitle"><span class="permalink"><a href="#aaeaceb452361377ce73db0041edbcdff">&#9670;&nbsp;</a></span>println() <span class="overload">[2/4]</span></h2>
  642. <div class="memitem">
  643. <div class="memproto">
  644. <div class="memtemplate">
  645. template&lt;typename WriteClass , uint8_t BUF_DIM&gt; </div>
  646. <table class="mlabels">
  647. <tr>
  648. <td class="mlabels-left">
  649. <table class="memname">
  650. <tr>
  651. <td class="memname">size_t <a class="el" href="class_buffered_print.html">BufferedPrint</a>&lt; WriteClass, BUF_DIM &gt;::println </td>
  652. <td>(</td>
  653. <td class="paramtype">double&#160;</td>
  654. <td class="paramname"><em>d</em>, </td>
  655. </tr>
  656. <tr>
  657. <td class="paramkey"></td>
  658. <td></td>
  659. <td class="paramtype">uint8_t&#160;</td>
  660. <td class="paramname"><em>prec</em> = <code>2</code>&#160;</td>
  661. </tr>
  662. <tr>
  663. <td></td>
  664. <td>)</td>
  665. <td></td><td></td>
  666. </tr>
  667. </table>
  668. </td>
  669. <td class="mlabels-right">
  670. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  671. </tr>
  672. </table>
  673. </div><div class="memdoc">
  674. <p>Print a double followed by CR LF. </p><dl class="params"><dt>Parameters</dt><dd>
  675. <table class="params">
  676. <tr><td class="paramdir">[in]</td><td class="paramname">d</td><td>The number to be printed. </td></tr>
  677. <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>
  678. </table>
  679. </dd>
  680. </dl>
  681. <dl class="section return"><dt>Returns</dt><dd>true for success or false if an error occurs. </dd></dl>
  682. </div>
  683. </div>
  684. <a id="afc449966c5c7357fde925c6888669698"></a>
  685. <h2 class="memtitle"><span class="permalink"><a href="#afc449966c5c7357fde925c6888669698">&#9670;&nbsp;</a></span>println() <span class="overload">[3/4]</span></h2>
  686. <div class="memitem">
  687. <div class="memproto">
  688. <div class="memtemplate">
  689. template&lt;typename WriteClass , uint8_t BUF_DIM&gt; </div>
  690. <table class="mlabels">
  691. <tr>
  692. <td class="mlabels-left">
  693. <table class="memname">
  694. <tr>
  695. <td class="memname">size_t <a class="el" href="class_buffered_print.html">BufferedPrint</a>&lt; WriteClass, BUF_DIM &gt;::println </td>
  696. <td>(</td>
  697. <td class="paramtype">float&#160;</td>
  698. <td class="paramname"><em>f</em>, </td>
  699. </tr>
  700. <tr>
  701. <td class="paramkey"></td>
  702. <td></td>
  703. <td class="paramtype">uint8_t&#160;</td>
  704. <td class="paramname"><em>prec</em>&#160;</td>
  705. </tr>
  706. <tr>
  707. <td></td>
  708. <td>)</td>
  709. <td></td><td></td>
  710. </tr>
  711. </table>
  712. </td>
  713. <td class="mlabels-right">
  714. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  715. </tr>
  716. </table>
  717. </div><div class="memdoc">
  718. <p>Print a float followed by CR LF. </p><dl class="params"><dt>Parameters</dt><dd>
  719. <table class="params">
  720. <tr><td class="paramdir">[in]</td><td class="paramname">f</td><td>The number to be printed. </td></tr>
  721. <tr><td class="paramdir">[in]</td><td class="paramname">prec</td><td>Number of digits after decimal point. </td></tr>
  722. </table>
  723. </dd>
  724. </dl>
  725. <dl class="section return"><dt>Returns</dt><dd>true for success or false if an error occurs. </dd></dl>
  726. </div>
  727. </div>
  728. <a id="a0945ed373bd17a309bb6661faad3be9c"></a>
  729. <h2 class="memtitle"><span class="permalink"><a href="#a0945ed373bd17a309bb6661faad3be9c">&#9670;&nbsp;</a></span>println() <span class="overload">[4/4]</span></h2>
  730. <div class="memitem">
  731. <div class="memproto">
  732. <div class="memtemplate">
  733. template&lt;typename WriteClass , uint8_t BUF_DIM&gt; </div>
  734. <div class="memtemplate">
  735. template&lt;typename Type &gt; </div>
  736. <table class="mlabels">
  737. <tr>
  738. <td class="mlabels-left">
  739. <table class="memname">
  740. <tr>
  741. <td class="memname">size_t <a class="el" href="class_buffered_print.html">BufferedPrint</a>&lt; WriteClass, BUF_DIM &gt;::println </td>
  742. <td>(</td>
  743. <td class="paramtype">Type&#160;</td>
  744. <td class="paramname"><em>v</em></td><td>)</td>
  745. <td></td>
  746. </tr>
  747. </table>
  748. </td>
  749. <td class="mlabels-right">
  750. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  751. </tr>
  752. </table>
  753. </div><div class="memdoc">
  754. <p>Print character, string, or number followed by CR LF. </p><dl class="params"><dt>Parameters</dt><dd>
  755. <table class="params">
  756. <tr><td class="paramdir">[in]</td><td class="paramname">v</td><td>item to print. </td></tr>
  757. </table>
  758. </dd>
  759. </dl>
  760. <dl class="section return"><dt>Returns</dt><dd>true for success or false if an error occurs. </dd></dl>
  761. </div>
  762. </div>
  763. <a id="a2253d1e7f231b94b18eab1281c123a49"></a>
  764. <h2 class="memtitle"><span class="permalink"><a href="#a2253d1e7f231b94b18eab1281c123a49">&#9670;&nbsp;</a></span>sync()</h2>
  765. <div class="memitem">
  766. <div class="memproto">
  767. <div class="memtemplate">
  768. template&lt;typename WriteClass , uint8_t BUF_DIM&gt; </div>
  769. <table class="mlabels">
  770. <tr>
  771. <td class="mlabels-left">
  772. <table class="memname">
  773. <tr>
  774. <td class="memname">bool <a class="el" href="class_buffered_print.html">BufferedPrint</a>&lt; WriteClass, BUF_DIM &gt;::sync </td>
  775. <td>(</td>
  776. <td class="paramname"></td><td>)</td>
  777. <td></td>
  778. </tr>
  779. </table>
  780. </td>
  781. <td class="mlabels-right">
  782. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  783. </tr>
  784. </table>
  785. </div><div class="memdoc">
  786. <p>Flush the buffer. </p><dl class="section return"><dt>Returns</dt><dd>true for success or false if an error occurs. </dd></dl>
  787. </div>
  788. </div>
  789. <a id="ab41de6eca77a04a49a6fc965b1950fc5"></a>
  790. <h2 class="memtitle"><span class="permalink"><a href="#ab41de6eca77a04a49a6fc965b1950fc5">&#9670;&nbsp;</a></span>write()</h2>
  791. <div class="memitem">
  792. <div class="memproto">
  793. <div class="memtemplate">
  794. template&lt;typename WriteClass , uint8_t BUF_DIM&gt; </div>
  795. <table class="mlabels">
  796. <tr>
  797. <td class="mlabels-left">
  798. <table class="memname">
  799. <tr>
  800. <td class="memname">size_t <a class="el" href="class_buffered_print.html">BufferedPrint</a>&lt; WriteClass, BUF_DIM &gt;::write </td>
  801. <td>(</td>
  802. <td class="paramtype">const void *&#160;</td>
  803. <td class="paramname"><em>src</em>, </td>
  804. </tr>
  805. <tr>
  806. <td class="paramkey"></td>
  807. <td></td>
  808. <td class="paramtype">size_t&#160;</td>
  809. <td class="paramname"><em>n</em>&#160;</td>
  810. </tr>
  811. <tr>
  812. <td></td>
  813. <td>)</td>
  814. <td></td><td></td>
  815. </tr>
  816. </table>
  817. </td>
  818. <td class="mlabels-right">
  819. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  820. </tr>
  821. </table>
  822. </div><div class="memdoc">
  823. <p>Write data to an open file. </p><dl class="params"><dt>Parameters</dt><dd>
  824. <table class="params">
  825. <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>Pointer to the location of the data to be written.</td></tr>
  826. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Number of bytes to write.</td></tr>
  827. </table>
  828. </dd>
  829. </dl>
  830. <dl class="section return"><dt>Returns</dt><dd>For success <a class="el" href="class_buffered_print.html#ab41de6eca77a04a49a6fc965b1950fc5">write()</a> returns the number of bytes written, always <em>n</em>. </dd></dl>
  831. </div>
  832. </div>
  833. <hr/>The documentation for this class was generated from the following file:<ul>
  834. <li>ArduinoSdFat/libraries/SdFat/src/<a class="el" href="_buffered_print_8h.html">BufferedPrint.h</a></li>
  835. </ul>
  836. </div><!-- contents -->
  837. <!-- start footer part -->
  838. <hr class="footer"/><address class="footer"><small>
  839. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  840. <img class="footer" src="doxygen.png" alt="doxygen"/>
  841. </a> 1.8.16
  842. </small></address>
  843. </body>
  844. </html>