ardupilot/libraries/doc/html/class_data_flash___class.html

397 lines
18 KiB
HTML
Raw Normal View History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>ArduPilot Libraries: DataFlash_Class Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> </div>
<div class="headertitle">
<h1>DataFlash_Class Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="DataFlash_Class" -->
<p><code>#include &lt;<a class="el" href="_data_flash_8h_source.html">DataFlash.h</a>&gt;</code></p>
<p><a href="class_data_flash___class-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_flash___class.html#abcc7740c0c53f4594363724b8d11507e">DataFlash_Class</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_flash___class.html#a5fdc7b891bfc48371cc07cf0fa659a71">Init</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_flash___class.html#a213908bcc4846bb7425a910da9295d44">ReadManufacturerID</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_flash___class.html#a113d7be25c6f015b6a8bb3f909771281">GetPage</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_flash___class.html#a8aa52719daf5fa94306eb0f4d6ff7f28">GetWritePage</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_flash___class.html#ab311b3c84c326b3164f6669e94644866">PageErase</a> (unsigned int PageAdr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_flash___class.html#a2fcdc28eaa3667bb47f93a23bdc8855d">StartWrite</a> (int PageAdr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_flash___class.html#a8c6c11c560d68667b326e52cc982d370">WriteByte</a> (unsigned char data)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_flash___class.html#ad2cb46986e1be119087204ca546ef5a2">WriteInt</a> (int data)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_flash___class.html#aea5b8b87899d47b1daabe5e75204f8e9">WriteLong</a> (long data)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_flash___class.html#af5e4a1c7035f798620666eb58ea29e96">StartRead</a> (int PageAdr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_flash___class.html#afc7e765678010e275d581746bb25cd6f">ReadByte</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_flash___class.html#a3da4020c0dab08fba5d1040c98d1adcc">ReadInt</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_flash___class.html#a389c31bb2e704bf92af0d168021cdaa1">ReadLong</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_flash___class.html#ad575934014354e081340a96073159d79">df_manufacturer</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_flash___class.html#a59c96ff23d9ae8c64b76f1a41b0a82c0">df_device_0</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_flash___class.html#acacd168d6bf0cf536492ec857d134b40">df_device_1</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="_data_flash_8h_source.html#l00041">41</a> of file <a class="el" href="_data_flash_8h_source.html">DataFlash.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="abcc7740c0c53f4594363724b8d11507e"></a><!-- doxytag: member="DataFlash_Class::DataFlash_Class" ref="abcc7740c0c53f4594363724b8d11507e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DataFlash_Class::DataFlash_Class </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_data_flash_8cpp_source.html#l00064">64</a> of file <a class="el" href="_data_flash_8cpp_source.html">DataFlash.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a113d7be25c6f015b6a8bb3f909771281"></a><!-- doxytag: member="DataFlash_Class::GetPage" ref="a113d7be25c6f015b6a8bb3f909771281" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DataFlash_Class::GetPage </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_data_flash_8cpp_source.html#l00285">285</a> of file <a class="el" href="_data_flash_8cpp_source.html">DataFlash.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8aa52719daf5fa94306eb0f4d6ff7f28"></a><!-- doxytag: member="DataFlash_Class::GetWritePage" ref="a8aa52719daf5fa94306eb0f4d6ff7f28" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DataFlash_Class::GetWritePage </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_data_flash_8cpp_source.html#l00279">279</a> of file <a class="el" href="_data_flash_8cpp_source.html">DataFlash.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5fdc7b891bfc48371cc07cf0fa659a71"></a><!-- doxytag: member="DataFlash_Class::Init" ref="a5fdc7b891bfc48371cc07cf0fa659a71" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DataFlash_Class::Init </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_data_flash_8cpp_source.html#l00069">69</a> of file <a class="el" href="_data_flash_8cpp_source.html">DataFlash.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab311b3c84c326b3164f6669e94644866"></a><!-- doxytag: member="DataFlash_Class::PageErase" ref="ab311b3c84c326b3164f6669e94644866" args="(unsigned int PageAdr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DataFlash_Class::PageErase </td>
<td>(</td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>PageAdr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_data_flash_8cpp_source.html#l00211">211</a> of file <a class="el" href="_data_flash_8cpp_source.html">DataFlash.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="afc7e765678010e275d581746bb25cd6f"></a><!-- doxytag: member="DataFlash_Class::ReadByte" ref="afc7e765678010e275d581746bb25cd6f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">byte DataFlash_Class::ReadByte </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_data_flash_8cpp_source.html#l00300">300</a> of file <a class="el" href="_data_flash_8cpp_source.html">DataFlash.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3da4020c0dab08fba5d1040c98d1adcc"></a><!-- doxytag: member="DataFlash_Class::ReadInt" ref="a3da4020c0dab08fba5d1040c98d1adcc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DataFlash_Class::ReadInt </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_data_flash_8cpp_source.html#l00321">321</a> of file <a class="el" href="_data_flash_8cpp_source.html">DataFlash.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a389c31bb2e704bf92af0d168021cdaa1"></a><!-- doxytag: member="DataFlash_Class::ReadLong" ref="a389c31bb2e704bf92af0d168021cdaa1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long DataFlash_Class::ReadLong </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_data_flash_8cpp_source.html#l00330">330</a> of file <a class="el" href="_data_flash_8cpp_source.html">DataFlash.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a213908bcc4846bb7425a910da9295d44"></a><!-- doxytag: member="DataFlash_Class::ReadManufacturerID" ref="a213908bcc4846bb7425a910da9295d44" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DataFlash_Class::ReadManufacturerID </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_data_flash_8cpp_source.html#l00100">100</a> of file <a class="el" href="_data_flash_8cpp_source.html">DataFlash.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af5e4a1c7035f798620666eb58ea29e96"></a><!-- doxytag: member="DataFlash_Class::StartRead" ref="af5e4a1c7035f798620666eb58ea29e96" args="(int PageAdr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DataFlash_Class::StartRead </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>PageAdr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_data_flash_8cpp_source.html#l00290">290</a> of file <a class="el" href="_data_flash_8cpp_source.html">DataFlash.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2fcdc28eaa3667bb47f93a23bdc8855d"></a><!-- doxytag: member="DataFlash_Class::StartWrite" ref="a2fcdc28eaa3667bb47f93a23bdc8855d" args="(int PageAdr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DataFlash_Class::StartWrite </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>PageAdr</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_data_flash_8cpp_source.html#l00225">225</a> of file <a class="el" href="_data_flash_8cpp_source.html">DataFlash.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8c6c11c560d68667b326e52cc982d370"></a><!-- doxytag: member="DataFlash_Class::WriteByte" ref="a8c6c11c560d68667b326e52cc982d370" args="(unsigned char data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DataFlash_Class::WriteByte </td>
<td>(</td>
<td class="paramtype">unsigned char&nbsp;</td>
<td class="paramname"> <em>data</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad2cb46986e1be119087204ca546ef5a2"></a><!-- doxytag: member="DataFlash_Class::WriteInt" ref="ad2cb46986e1be119087204ca546ef5a2" args="(int data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DataFlash_Class::WriteInt </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>data</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_data_flash_8cpp_source.html#l00264">264</a> of file <a class="el" href="_data_flash_8cpp_source.html">DataFlash.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aea5b8b87899d47b1daabe5e75204f8e9"></a><!-- doxytag: member="DataFlash_Class::WriteLong" ref="aea5b8b87899d47b1daabe5e75204f8e9" args="(long data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DataFlash_Class::WriteLong </td>
<td>(</td>
<td class="paramtype">long&nbsp;</td>
<td class="paramname"> <em>data</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_data_flash_8cpp_source.html#l00270">270</a> of file <a class="el" href="_data_flash_8cpp_source.html">DataFlash.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a59c96ff23d9ae8c64b76f1a41b0a82c0"></a><!-- doxytag: member="DataFlash_Class::df_device_0" ref="a59c96ff23d9ae8c64b76f1a41b0a82c0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char <a class="el" href="class_data_flash___class.html#a59c96ff23d9ae8c64b76f1a41b0a82c0">DataFlash_Class::df_device_0</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_data_flash_8h_source.html#l00063">63</a> of file <a class="el" href="_data_flash_8h_source.html">DataFlash.h</a>.</p>
</div>
</div>
<a class="anchor" id="acacd168d6bf0cf536492ec857d134b40"></a><!-- doxytag: member="DataFlash_Class::df_device_1" ref="acacd168d6bf0cf536492ec857d134b40" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char <a class="el" href="class_data_flash___class.html#acacd168d6bf0cf536492ec857d134b40">DataFlash_Class::df_device_1</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_data_flash_8h_source.html#l00064">64</a> of file <a class="el" href="_data_flash_8h_source.html">DataFlash.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad575934014354e081340a96073159d79"></a><!-- doxytag: member="DataFlash_Class::df_manufacturer" ref="ad575934014354e081340a96073159d79" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char <a class="el" href="class_data_flash___class.html#ad575934014354e081340a96073159d79">DataFlash_Class::df_manufacturer</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_data_flash_8h_source.html#l00062">62</a> of file <a class="el" href="_data_flash_8h_source.html">DataFlash.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/home/jgoppert/Projects/ap/libraries/DataFlash/<a class="el" href="_data_flash_8h_source.html">DataFlash.h</a></li>
<li>/home/jgoppert/Projects/ap/libraries/DataFlash/<a class="el" href="_data_flash_8cpp_source.html">DataFlash.cpp</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>
Generated for ArduPilot Libraries by&nbsp;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.png" alt="doxygen"/></a></small></address>
</body>
</html>