Diff: doc/html/_scan_result_8h_source.html

Revision:

16:7f1d6d359787

Parent:

14:85a2ed029f37

Child:

17:7268f365676b

--- a/doc/html/_scan_result_8h_source.html	Wed Aug 13 03:15:49 2014 -0700
+++ b/doc/html/_scan_result_8h_source.html	Wed Aug 13 04:41:04 2014 -0700
@@ -101,73 +101,64 @@
 <div class="title">ScanResult.h</div>  </div>
 </div><!--header-->
 <div class="contents">
-<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
-<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright 2014, ACKme Networks</span></div>
-<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * All Rights Reserved.</span></div>
-<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div>
-<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * This is UNPUBLISHED PROPRIETARY SOURCE CODE of ACKme Networks;</span></div>
-<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * the contents of this file may not be disclosed to third parties, copied</span></div>
-<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * or duplicated in any form, in whole or in part, without the prior</span></div>
-<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * written permission of ACKme Networks.</span></div>
-<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> */</span></div>
-<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div>
-<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#pragma once</span></div>
-<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div>
-<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;</div>
-<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;</div>
-<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="preprocessor">#include &quot;WiconnectTypes.h&quot;</span></div>
-<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#include &quot;StringUtil.h&quot;</span></div>
-<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div>
-<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div>
-<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="keyword">namespace </span>wiconnect</div>
-<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;{</div>
-<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div>
-<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classwiconnect_1_1_scan_result.html">   28</a></span>&#160;<span class="keyword">class </span><a class="code" href="classwiconnect_1_1_scan_result.html">ScanResult</a></div>
-<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;{</div>
-<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="keyword">public</span>:</div>
-<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    uint8_t getChannel() <span class="keyword">const</span>;</div>
-<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    <a class="code" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a> getSignalStrength() <span class="keyword">const</span>;</div>
-<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;    <span class="keyword">const</span> <a class="code" href="structwiconnect_1_1_mac_address.html">MacAddress</a>* getMacAddress() <span class="keyword">const</span>;</div>
-<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;    <a class="code" href="group__api__network__types.html#ga026bd11cd5df47b7022362243e2d553f">NetworkSecurity</a> getSecurityType() <span class="keyword">const</span>;</div>
-<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    uint32_t getRate() <span class="keyword">const</span>;</div>
-<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;    <span class="keyword">const</span> <span class="keywordtype">char</span>* getRateStr(<span class="keywordtype">char</span> *buffer = NULL) <span class="keyword">const</span>;</div>
-<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    <span class="keyword">const</span> <a class="code" href="structwiconnect_1_1_ssid.html">Ssid</a>* getSsid() <span class="keyword">const</span>;</div>
-<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;</div>
-<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_scan_result.html">ScanResult</a>* getNext() <span class="keyword">const</span>;</div>
-<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_scan_result.html">ScanResult</a>* getPrevious() <span class="keyword">const</span>;</div>
-<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;</div>
-<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="keyword">protected</span>:</div>
-<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    <a class="code" href="classwiconnect_1_1_scan_result.html">ScanResult</a>();</div>
-<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;</div>
-<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> init(<span class="keyword">const</span> <span class="keywordtype">char</span> *channelStr, <span class="keyword">const</span> <span class="keywordtype">char</span> *rssiStr, <span class="keyword">const</span> <span class="keywordtype">char</span>* macStr, <span class="keyword">const</span> <span class="keywordtype">char</span> *rateStr, <span class="keyword">const</span> <span class="keywordtype">char</span> *secStr, <span class="keyword">const</span> <span class="keywordtype">char</span> *ssidStr);</div>
-<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    <a class="code" href="classwiconnect_1_1_scan_result.html">ScanResult</a> *next;</div>
-<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    <a class="code" href="classwiconnect_1_1_scan_result.html">ScanResult</a> *previous;</div>
-<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    uint8_t channel;</div>
-<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    int16_t rssi;</div>
-<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <a class="code" href="structwiconnect_1_1_mac_address.html">MacAddress</a> mac;</div>
-<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    uint32_t rate;</div>
-<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    <a class="code" href="group__api__network__types.html#ga026bd11cd5df47b7022362243e2d553f">NetworkSecurity</a> security;</div>
-<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    <a class="code" href="structwiconnect_1_1_ssid.html">Ssid</a> ssid;</div>
-<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;</div>
-<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    <span class="keywordtype">void</span>* <span class="keyword">operator</span> <span class="keyword">new</span>(<span class="keywordtype">size_t</span> size);</div>
-<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    <span class="keywordtype">void</span> <span class="keyword">operator</span> <span class="keyword">delete</span>(<span class="keywordtype">void</span>*);</div>
-<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;</div>
-<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_scan_result_list.html">ScanResultList</a>;</div>
-<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;};</div>
-<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div>
-<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;</div>
+<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;</div>
+<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#pragma once</span></div>
+<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div>
+<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div>
+<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;</div>
+<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#include &quot;WiconnectTypes.h&quot;</span></div>
+<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#include &quot;StringUtil.h&quot;</span></div>
+<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;</div>
+<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div>
+<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="keyword">namespace </span>wiconnect</div>
+<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;{</div>
+<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div>
+<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classwiconnect_1_1_scan_result.html">   46</a></span>&#160;<span class="keyword">class </span><a class="code" href="classwiconnect_1_1_scan_result.html">ScanResult</a></div>
+<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;{</div>
+<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="keyword">public</span>:</div>
+<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    uint8_t getChannel() <span class="keyword">const</span>;</div>
+<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <a class="code" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a> getSignalStrength() <span class="keyword">const</span>;</div>
+<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    <span class="keyword">const</span> <a class="code" href="structwiconnect_1_1_mac_address.html">MacAddress</a>* getMacAddress() <span class="keyword">const</span>;</div>
+<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    <a class="code" href="group__api__network__types.html#ga026bd11cd5df47b7022362243e2d553f">NetworkSecurity</a> getSecurityType() <span class="keyword">const</span>;</div>
+<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    uint32_t getRate() <span class="keyword">const</span>;</div>
+<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    <span class="keyword">const</span> <span class="keywordtype">char</span>* getRateStr(<span class="keywordtype">char</span> *buffer = NULL) <span class="keyword">const</span>;</div>
+<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    <span class="keyword">const</span> <a class="code" href="structwiconnect_1_1_ssid.html">Ssid</a>* getSsid() <span class="keyword">const</span>;</div>
+<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;</div>
+<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_scan_result.html">ScanResult</a>* getNext() <span class="keyword">const</span>;</div>
+<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_scan_result.html">ScanResult</a>* getPrevious() <span class="keyword">const</span>;</div>
+<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div>
+<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="keyword">protected</span>:</div>
+<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    <a class="code" href="classwiconnect_1_1_scan_result.html">ScanResult</a>();</div>
 <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;</div>
-<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;</div>
-<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div>
-<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;</div>
-<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;}</div>
-<div class="ttc" id="group__api__network__types_html_ga026bd11cd5df47b7022362243e2d553f"><div class="ttname"><a href="group__api__network__types.html#ga026bd11cd5df47b7022362243e2d553f">wiconnect::NetworkSecurity</a></div><div class="ttdeci">NetworkSecurity</div><div class="ttdoc">Network security type. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00217">WiconnectTypes.h:217</a></div></div>
-<div class="ttc" id="group__api__core__types_html_ga325637ed501728bd6c8c7a7982b9ce05"><div class="ttname"><a href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">wiconnect::WiconnectResult</a></div><div class="ttdeci">WiconnectResult</div><div class="ttdoc">API Result code. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00127">WiconnectTypes.h:127</a></div></div>
-<div class="ttc" id="structwiconnect_1_1_mac_address_html"><div class="ttname"><a href="structwiconnect_1_1_mac_address.html">wiconnect::MacAddress</a></div><div class="ttdoc">Network MAC Address type. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00243">WiconnectTypes.h:243</a></div></div>
-<div class="ttc" id="group__api__network__types_html_gac5aead2b4cca0122a60168e75ea41d36"><div class="ttname"><a href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">wiconnect::NetworkSignalStrength</a></div><div class="ttdeci">NetworkSignalStrength</div><div class="ttdoc">Network RSSI signal level. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00203">WiconnectTypes.h:203</a></div></div>
-<div class="ttc" id="structwiconnect_1_1_ssid_html"><div class="ttname"><a href="structwiconnect_1_1_ssid.html">wiconnect::Ssid</a></div><div class="ttdoc">Network SSID type. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00233">WiconnectTypes.h:233</a></div></div>
-<div class="ttc" id="classwiconnect_1_1_scan_result_list_html"><div class="ttname"><a href="classwiconnect_1_1_scan_result_list.html">wiconnect::ScanResultList</a></div><div class="ttdoc">List of WiFi network scan results. </div><div class="ttdef"><b>Definition:</b> <a href="_scan_result_list_8h_source.html#l00028">ScanResultList.h:28</a></div></div>
-<div class="ttc" id="classwiconnect_1_1_scan_result_html"><div class="ttname"><a href="classwiconnect_1_1_scan_result.html">wiconnect::ScanResult</a></div><div class="ttdoc">Contains single entry from WiFi scan results. </div><div class="ttdef"><b>Definition:</b> <a href="_scan_result_8h_source.html#l00028">ScanResult.h:28</a></div></div>
+<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> init(<span class="keyword">const</span> <span class="keywordtype">char</span> *channelStr, <span class="keyword">const</span> <span class="keywordtype">char</span> *rssiStr, <span class="keyword">const</span> <span class="keywordtype">char</span>* macStr, <span class="keyword">const</span> <span class="keywordtype">char</span> *rateStr, <span class="keyword">const</span> <span class="keywordtype">char</span> *secStr, <span class="keyword">const</span> <span class="keywordtype">char</span> *ssidStr);</div>
+<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <a class="code" href="classwiconnect_1_1_scan_result.html">ScanResult</a> *next;</div>
+<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    <a class="code" href="classwiconnect_1_1_scan_result.html">ScanResult</a> *previous;</div>
+<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    uint8_t channel;</div>
+<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    int16_t rssi;</div>
+<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    <a class="code" href="structwiconnect_1_1_mac_address.html">MacAddress</a> mac;</div>
+<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    uint32_t rate;</div>
+<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    <a class="code" href="group__api__network__types.html#ga026bd11cd5df47b7022362243e2d553f">NetworkSecurity</a> security;</div>
+<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    <a class="code" href="structwiconnect_1_1_ssid.html">Ssid</a> ssid;</div>
+<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;</div>
+<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    <span class="keywordtype">void</span>* <span class="keyword">operator</span> <span class="keyword">new</span>(<span class="keywordtype">size_t</span> size);</div>
+<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    <span class="keywordtype">void</span> <span class="keyword">operator</span> <span class="keyword">delete</span>(<span class="keywordtype">void</span>*);</div>
+<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;</div>
+<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_scan_result_list.html">ScanResultList</a>;</div>
+<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;};</div>
+<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div>
+<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;</div>
+<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;</div>
+<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;</div>
+<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;</div>
+<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;</div>
+<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;}</div>
+<div class="ttc" id="group__api__network__types_html_ga026bd11cd5df47b7022362243e2d553f"><div class="ttname"><a href="group__api__network__types.html#ga026bd11cd5df47b7022362243e2d553f">wiconnect::NetworkSecurity</a></div><div class="ttdeci">NetworkSecurity</div><div class="ttdoc">Network security type. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00235">WiconnectTypes.h:235</a></div></div>
+<div class="ttc" id="group__api__core__types_html_ga325637ed501728bd6c8c7a7982b9ce05"><div class="ttname"><a href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">wiconnect::WiconnectResult</a></div><div class="ttdeci">WiconnectResult</div><div class="ttdoc">API Result code. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00145">WiconnectTypes.h:145</a></div></div>
+<div class="ttc" id="structwiconnect_1_1_mac_address_html"><div class="ttname"><a href="structwiconnect_1_1_mac_address.html">wiconnect::MacAddress</a></div><div class="ttdoc">Network MAC Address type. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00261">WiconnectTypes.h:261</a></div></div>
+<div class="ttc" id="group__api__network__types_html_gac5aead2b4cca0122a60168e75ea41d36"><div class="ttname"><a href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">wiconnect::NetworkSignalStrength</a></div><div class="ttdeci">NetworkSignalStrength</div><div class="ttdoc">Network RSSI signal level. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00221">WiconnectTypes.h:221</a></div></div>
+<div class="ttc" id="structwiconnect_1_1_ssid_html"><div class="ttname"><a href="structwiconnect_1_1_ssid.html">wiconnect::Ssid</a></div><div class="ttdoc">Network SSID type. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00251">WiconnectTypes.h:251</a></div></div>
+<div class="ttc" id="classwiconnect_1_1_scan_result_list_html"><div class="ttname"><a href="classwiconnect_1_1_scan_result_list.html">wiconnect::ScanResultList</a></div><div class="ttdoc">List of WiFi network scan results. </div><div class="ttdef"><b>Definition:</b> <a href="_scan_result_list_8h_source.html#l00046">ScanResultList.h:46</a></div></div>
+<div class="ttc" id="classwiconnect_1_1_scan_result_html"><div class="ttname"><a href="classwiconnect_1_1_scan_result.html">wiconnect::ScanResult</a></div><div class="ttdoc">Contains single entry from WiFi scan results. </div><div class="ttdef"><b>Definition:</b> <a href="_scan_result_8h_source.html#l00046">ScanResult.h:46</a></div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->