Updated documentation

michalmonday · michalmonday · commit ba06bd5df35b · 2020-10-01T16:01:10.000+01:00
diff --git a/docs/_c_s_v___parser_8cpp.html b/docs/_c_s_v___parser_8cpp.html
@@ -66,6 +66,7 @@
 </div><!--header-->
 <div class="contents">
 <div class="textblock"><code>#include &quot;<a class="el" href="_c_s_v___parser_8h_source.html">CSV_Parser.h</a>&quot;</code><br />
+<code>#include &lt;SD.h&gt;</code><br />
 </div></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
diff --git a/docs/_c_s_v___parser_8h_source.html b/docs/_c_s_v___parser_8h_source.html
diff --git a/docs/class_c_s_v___parser-members.html b/docs/class_c_s_v___parser-members.html
@@ -83,7 +83,8 @@
   <tr class="even"><td class="entry"><a class="el" href="class_c_s_v___parser.html#aafbdf5883363d81d2f494025a247a0f7">parseLeftover</a>()</td><td class="entry"><a class="el" href="class_c_s_v___parser.html">CSV_Parser</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="class_c_s_v___parser.html#a8945f77049c64f6a59b08c146caa04d3">print</a>(Stream &amp;ser=Serial)</td><td class="entry"><a class="el" href="class_c_s_v___parser.html">CSV_Parser</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_c_s_v___parser.html#a9e8b2eda58fcdd6a9e3da2f0c012e493">printKeys</a>(Stream &amp;ser=Serial)</td><td class="entry"><a class="el" href="class_c_s_v___parser.html">CSV_Parser</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="class_c_s_v___parser.html#a1e4436ea4baef41584667d55ccf31983">~CSV_Parser</a>()</td><td class="entry"><a class="el" href="class_c_s_v___parser.html">CSV_Parser</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="class_c_s_v___parser.html#ac127ae6fb3f70b1a7fe841385675d2a7">readSDfile</a>(const char *f_name)</td><td class="entry"><a class="el" href="class_c_s_v___parser.html">CSV_Parser</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_c_s_v___parser.html#a1e4436ea4baef41584667d55ccf31983">~CSV_Parser</a>()</td><td class="entry"><a class="el" href="class_c_s_v___parser.html">CSV_Parser</a></td><td class="entry"></td></tr>
 </table></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
diff --git a/docs/class_c_s_v___parser.html b/docs/class_c_s_v___parser.html
@@ -91,6 +91,9 @@
  Making values unusable once the <a class="el" href="class_c_s_v___parser.html">CSV_Parser</a> goes out of scope. <br  />
   <a href="class_c_s_v___parser.html#a1e4436ea4baef41584667d55ccf31983">More...</a><br /></td></tr>
 <tr class="separator:a1e4436ea4baef41584667d55ccf31983"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ac127ae6fb3f70b1a7fe841385675d2a7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_v___parser.html#ac127ae6fb3f70b1a7fe841385675d2a7">readSDfile</a> (const char *f_name)</td></tr>
+<tr class="memdesc:ac127ae6fb3f70b1a7fe841385675d2a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads file from SD card.  <a href="class_c_s_v___parser.html#ac127ae6fb3f70b1a7fe841385675d2a7">More...</a><br /></td></tr>
+<tr class="separator:ac127ae6fb3f70b1a7fe841385675d2a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:adcf07ca7590aace95e8607ebf3ce2521"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_v___parser.html#adcf07ca7590aace95e8607ebf3ce2521">getColumnsCount</a> ()</td></tr>
 <tr class="separator:adcf07ca7590aace95e8607ebf3ce2521"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a41ff94800b60aa976d10db7071957560"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_v___parser.html#a41ff94800b60aa976d10db7071957560">getRowsCount</a> ()</td></tr>
@@ -662,6 +665,34 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9e8b2eda58fcdd6a9e3da2f0
       </table>
 </div><div class="memdoc">
 
+</div>
+</div>
+<a id="ac127ae6fb3f70b1a7fe841385675d2a7"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ac127ae6fb3f70b1a7fe841385675d2a7">&#9670;&nbsp;</a></span>readSDfile()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool CSV_Parser::readSDfile </td>
+          <td>(</td>
+          <td class="paramtype">const char *&#160;</td>
+          <td class="paramname"><em>f_name</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Reads file from SD card. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">f_name</td><td>- file name (provided file must have format that was supplied in <a class="el" href="class_c_s_v___parser.html">CSV_Parser</a> constructor) </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>True if file could be read, false if not. It requires previously calling "SD.begin()". <br  />
+ </dd></dl>
+
 </div>
 </div>
 <hr/>The documentation for this class was generated from the following files:<ul>
diff --git a/docs/functions.html b/docs/functions.html
@@ -89,6 +89,9 @@
 <li>printKeys()
 : <a class="el" href="class_c_s_v___parser.html#a9e8b2eda58fcdd6a9e3da2f0c012e493">CSV_Parser</a>
 </li>
+<li>readSDfile()
+: <a class="el" href="class_c_s_v___parser.html#ac127ae6fb3f70b1a7fe841385675d2a7">CSV_Parser</a>
+</li>
 <li>~CSV_Parser()
 : <a class="el" href="class_c_s_v___parser.html#a1e4436ea4baef41584667d55ccf31983">CSV_Parser</a>
 </li>
diff --git a/docs/functions_func.html b/docs/functions_func.html
@@ -89,6 +89,9 @@
 <li>printKeys()
 : <a class="el" href="class_c_s_v___parser.html#a9e8b2eda58fcdd6a9e3da2f0c012e493">CSV_Parser</a>
 </li>
+<li>readSDfile()
+: <a class="el" href="class_c_s_v___parser.html#ac127ae6fb3f70b1a7fe841385675d2a7">CSV_Parser</a>
+</li>
 <li>~CSV_Parser()
 : <a class="el" href="class_c_s_v___parser.html#a1e4436ea4baef41584667d55ccf31983">CSV_Parser</a>
 </li>
diff --git a/docs/md__r_e_a_d_m_e.html b/docs/md__r_e_a_d_m_e.html
@@ -270,7 +270,16 @@ <h1><a class="anchor" id="autotoc_md3"></a>
 </p>
 <p>Notice that it's possible to customize the quote char as shown in <a href="#custom-quote-character">this section</a>. E.g. to use single quotes (') instead. <br  />
 </p>
-<h1><a class="anchor" id="autotoc_md6"></a>
+<p><b>Header fields leading and trailing spaces are ignored</b> <br  />
+ Example: <br  />
+ </p><div class="fragment"><div class="line"><span class="keywordtype">char</span> * csv_str = <span class="stringliteral">&quot;  test a  ,  test b  \n&quot;</span> <span class="comment">// header names include leading and trailing spaces</span></div>
+<div class="line">                 <span class="stringliteral">&quot;1,2\n&quot;</span></div>
+<div class="line">                 <span class="stringliteral">&quot;3,4\n&quot;</span>;</div>
+<div class="line">     </div>
+<div class="line"><a class="code" href="class_c_s_v___parser.html">CSV_Parser</a> cp(csv_str, <span class="stringliteral">&quot;cc&quot;</span>);</div>
+<div class="line">int8_t *a = (int8_t*)cp[<span class="stringliteral">&quot;test a&quot;</span>]; <span class="comment">// notice how &quot;test a&quot; is used instead of &quot;  test a  &quot;</span></div>
+<div class="line">int8_t *b = (int8_t*)cp[<span class="stringliteral">&quot;test b&quot;</span>];</div>
+</div><!-- fragment --><h1><a class="anchor" id="autotoc_md6"></a>
 Specifying value types</h1>
 <div class="fragment"><div class="line"><span class="keywordtype">char</span> * csv_str = <span class="stringliteral">&quot;my_strings,my_floats\n&quot;</span></div>
 <div class="line">         <span class="stringliteral">&quot;hello,1.1\n&quot;</span></div>
diff --git a/docs/search/all_6.js b/docs/search/all_6.js
@@ -1,4 +1,5 @@
 var searchData=
 [
-  ['readme_2emd_14',['README.md',['../_r_e_a_d_m_e_8md.html',1,'']]]
+  ['readme_2emd_14',['README.md',['../_r_e_a_d_m_e_8md.html',1,'']]],
+  ['readsdfile_15',['readSDfile',['../class_c_s_v___parser.html#ac127ae6fb3f70b1a7fe841385675d2a7',1,'CSV_Parser']]]
 ];
diff --git a/docs/search/all_7.js b/docs/search/all_7.js
@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['table_20of_20contents_15',['Table of contents',['../md__r_e_a_d_m_e.html',1,'']]]
+  ['table_20of_20contents_16',['Table of contents',['../md__r_e_a_d_m_e.html',1,'']]]
 ];
diff --git a/docs/search/all_8.js b/docs/search/all_8.js
@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['_7ecsv_5fparser_16',['~CSV_Parser',['../class_c_s_v___parser.html#a1e4436ea4baef41584667d55ccf31983',1,'CSV_Parser']]]
+  ['_7ecsv_5fparser_17',['~CSV_Parser',['../class_c_s_v___parser.html#a1e4436ea4baef41584667d55ccf31983',1,'CSV_Parser']]]
 ];
diff --git a/docs/search/classes_0.js b/docs/search/classes_0.js
@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['csv_5fparser_17',['CSV_Parser',['../class_c_s_v___parser.html',1,'']]]
+  ['csv_5fparser_18',['CSV_Parser',['../class_c_s_v___parser.html',1,'']]]
 ];
diff --git a/docs/search/files_0.js b/docs/search/files_0.js
@@ -1,5 +1,5 @@
 var searchData=
 [
-  ['csv_5fparser_2ecpp_18',['CSV_Parser.cpp',['../_c_s_v___parser_8cpp.html',1,'']]],
-  ['csv_5fparser_2eh_19',['CSV_Parser.h',['../_c_s_v___parser_8h.html',1,'']]]
+  ['csv_5fparser_2ecpp_19',['CSV_Parser.cpp',['../_c_s_v___parser_8cpp.html',1,'']]],
+  ['csv_5fparser_2eh_20',['CSV_Parser.h',['../_c_s_v___parser_8h.html',1,'']]]
 ];
diff --git a/docs/search/files_1.js b/docs/search/files_1.js
@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['documentation_5fconfig_2etxt_20',['documentation_config.txt',['../documentation__config_8txt.html',1,'']]]
+  ['documentation_5fconfig_2etxt_21',['documentation_config.txt',['../documentation__config_8txt.html',1,'']]]
 ];
diff --git a/docs/search/files_2.js b/docs/search/files_2.js
@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['keywords_2etxt_21',['keywords.txt',['../keywords_8txt.html',1,'']]]
+  ['keywords_2etxt_22',['keywords.txt',['../keywords_8txt.html',1,'']]]
 ];
diff --git a/docs/search/files_3.js b/docs/search/files_3.js
@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['readme_2emd_22',['README.md',['../_r_e_a_d_m_e_8md.html',1,'']]]
+  ['readme_2emd_23',['README.md',['../_r_e_a_d_m_e_8md.html',1,'']]]
 ];
diff --git a/docs/search/functions_0.js b/docs/search/functions_0.js
diff --git a/docs/search/functions_1.js b/docs/search/functions_1.js
@@ -1,6 +1,6 @@
 var searchData=
 [
-  ['getcolumnscount_24',['getColumnsCount',['../class_c_s_v___parser.html#adcf07ca7590aace95e8607ebf3ce2521',1,'CSV_Parser']]],
-  ['getrowscount_25',['getRowsCount',['../class_c_s_v___parser.html#a41ff94800b60aa976d10db7071957560',1,'CSV_Parser']]],
-  ['getvalues_26',['getValues',['../class_c_s_v___parser.html#a9d66220e48bc0bc46428910e854fd190',1,'CSV_Parser::getValues(const char *key)'],['../class_c_s_v___parser.html#ab51ce2cb2974329038d1c86f7af5a396',1,'CSV_Parser::getValues(int col_index)']]]
+  ['getcolumnscount_25',['getColumnsCount',['../class_c_s_v___parser.html#adcf07ca7590aace95e8607ebf3ce2521',1,'CSV_Parser']]],
+  ['getrowscount_26',['getRowsCount',['../class_c_s_v___parser.html#a41ff94800b60aa976d10db7071957560',1,'CSV_Parser']]],
+  ['getvalues_27',['getValues',['../class_c_s_v___parser.html#a9d66220e48bc0bc46428910e854fd190',1,'CSV_Parser::getValues(const char *key)'],['../class_c_s_v___parser.html#ab51ce2cb2974329038d1c86f7af5a396',1,'CSV_Parser::getValues(int col_index)']]]
 ];
diff --git a/docs/search/functions_2.js b/docs/search/functions_2.js
@@ -1,5 +1,5 @@
 var searchData=
 [
-  ['operator_3c_3c_27',['operator&lt;&lt;',['../class_c_s_v___parser.html#aed45a6caaac8e820d7818a77a9abdf7c',1,'CSV_Parser::operator&lt;&lt;(const char *s)'],['../class_c_s_v___parser.html#a376e45bf172be1016309a9c979343f3d',1,'CSV_Parser::operator&lt;&lt;(char c)']]],
-  ['operator_5b_5d_28',['operator[]',['../class_c_s_v___parser.html#abfcc311c0f24c5a816651c0366a22979',1,'CSV_Parser::operator[](const char *key)'],['../class_c_s_v___parser.html#aa59219b05b949c7a2ba7abbad5f9bc8c',1,'CSV_Parser::operator[](int col_index)']]]
+  ['operator_3c_3c_28',['operator&lt;&lt;',['../class_c_s_v___parser.html#aed45a6caaac8e820d7818a77a9abdf7c',1,'CSV_Parser::operator&lt;&lt;(const char *s)'],['../class_c_s_v___parser.html#a376e45bf172be1016309a9c979343f3d',1,'CSV_Parser::operator&lt;&lt;(char c)']]],
+  ['operator_5b_5d_29',['operator[]',['../class_c_s_v___parser.html#abfcc311c0f24c5a816651c0366a22979',1,'CSV_Parser::operator[](const char *key)'],['../class_c_s_v___parser.html#aa59219b05b949c7a2ba7abbad5f9bc8c',1,'CSV_Parser::operator[](int col_index)']]]
 ];
diff --git a/docs/search/functions_3.js b/docs/search/functions_3.js
@@ -1,6 +1,6 @@
 var searchData=
 [
-  ['parseleftover_29',['parseLeftover',['../class_c_s_v___parser.html#aafbdf5883363d81d2f494025a247a0f7',1,'CSV_Parser']]],
-  ['print_30',['print',['../class_c_s_v___parser.html#a8945f77049c64f6a59b08c146caa04d3',1,'CSV_Parser']]],
-  ['printkeys_31',['printKeys',['../class_c_s_v___parser.html#a9e8b2eda58fcdd6a9e3da2f0c012e493',1,'CSV_Parser']]]
+  ['parseleftover_30',['parseLeftover',['../class_c_s_v___parser.html#aafbdf5883363d81d2f494025a247a0f7',1,'CSV_Parser']]],
+  ['print_31',['print',['../class_c_s_v___parser.html#a8945f77049c64f6a59b08c146caa04d3',1,'CSV_Parser']]],
+  ['printkeys_32',['printKeys',['../class_c_s_v___parser.html#a9e8b2eda58fcdd6a9e3da2f0c012e493',1,'CSV_Parser']]]
 ];
diff --git a/docs/search/functions_4.js b/docs/search/functions_4.js
@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['_7ecsv_5fparser_32',['~CSV_Parser',['../class_c_s_v___parser.html#a1e4436ea4baef41584667d55ccf31983',1,'CSV_Parser']]]
+  ['readsdfile_33',['readSDfile',['../class_c_s_v___parser.html#ac127ae6fb3f70b1a7fe841385675d2a7',1,'CSV_Parser']]]
 ];
diff --git a/docs/search/functions_5.html b/docs/search/functions_5.html
@@ -0,0 +1,36 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html><head><title></title>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta name="generator" content="Doxygen 1.8.18"/>
+<link rel="stylesheet" type="text/css" href="search.css"/>
+<script type="text/javascript" src="functions_5.js"></script>
+<script type="text/javascript" src="search.js"></script>
+</head>
+<body class="SRPage">
+<div id="SRIndex">
+<div class="SRStatus" id="Loading">Loading...</div>
+<div id="SRResults"></div>
+<script type="text/javascript"><!--
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+createResults();
+/* @license-end */
+--></script>
+<div class="SRStatus" id="Searching">Searching...</div>
+<div class="SRStatus" id="NoMatches">No Matches</div>
+<script type="text/javascript"><!--
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+document.getElementById("Loading").style.display="none";
+document.getElementById("NoMatches").style.display="none";
+var searchResults = new SearchResults("searchResults");
+searchResults.Search();
+window.addEventListener("message", function(event) {
+  if (event.data == "take_focus") {
+    var elem = searchResults.NavNext(0);
+    if (elem) elem.focus();
+  }
+});
+/* @license-end */
+--></script>
+</div>
+</body>
+</html>
diff --git a/docs/search/functions_5.js b/docs/search/functions_5.js
@@ -0,0 +1,4 @@
+var searchData=
+[
+  ['_7ecsv_5fparser_34',['~CSV_Parser',['../class_c_s_v___parser.html#a1e4436ea4baef41584667d55ccf31983',1,'CSV_Parser']]]
+];
diff --git a/docs/search/pages_0.js b/docs/search/pages_0.js
@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['csv_20parser_20for_20arduino_33',['CSV Parser for Arduino',['../index.html',1,'']]]
+  ['csv_20parser_20for_20arduino_35',['CSV Parser for Arduino',['../index.html',1,'']]]
 ];
diff --git a/docs/search/pages_1.js b/docs/search/pages_1.js
@@ -1,4 +1,4 @@
 var searchData=
 [
-  ['table_20of_20contents_34',['Table of contents',['../md__r_e_a_d_m_e.html',1,'']]]
+  ['table_20of_20contents_36',['Table of contents',['../md__r_e_a_d_m_e.html',1,'']]]
 ];
diff --git a/docs/search/searchdata.js b/docs/search/searchdata.js
@@ -3,7 +3,7 @@ var indexSectionsWithContent =
   0: "cdgkoprt~",
   1: "c",
   2: "cdkr",
-  3: "cgop~",
+  3: "cgopr~",
   4: "ct"
 };
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`var searchData=`
`2`	`2`	`[`
`3`		`- ['readme_2emd_14',['README.md',['../_r_e_a_d_m_e_8md.html',1,'']]]`
	`3`	`+ ['readme_2emd_14',['README.md',['../_r_e_a_d_m_e_8md.html',1,'']]],`
	`4`	`+ ['readsdfile_15',['readSDfile',['../class_c_s_v___parser.html#ac127ae6fb3f70b1a7fe841385675d2a7',1,'CSV_Parser']]]`
`4`	`5`	`];`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`var searchData=`
`2`	`2`	`[`
`3`		`- ['table_20of_20contents_15',['Table of contents',['../md__r_e_a_d_m_e.html',1,'']]]`
	`3`	`+ ['table_20of_20contents_16',['Table of contents',['../md__r_e_a_d_m_e.html',1,'']]]`
`4`	`4`	`];`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`var searchData=`
`2`	`2`	`[`
`3`		`- ['_7ecsv_5fparser_16',['~CSV_Parser',['../class_c_s_v___parser.html#a1e4436ea4baef41584667d55ccf31983',1,'CSV_Parser']]]`
	`3`	`+ ['_7ecsv_5fparser_17',['~CSV_Parser',['../class_c_s_v___parser.html#a1e4436ea4baef41584667d55ccf31983',1,'CSV_Parser']]]`
`4`	`4`	`];`