mirror of
https://github.com/ArduPilot/ardupilot
synced 2025-01-14 04:38:30 -04:00
317 lines
15 KiB
HTML
317 lines
15 KiB
HTML
|
<!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: AP_VarI 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 Page</span></a></li>
|
||
|
|
<li><a href="pages.html"><span>Related Pages</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 List</span></a></li>
|
||
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="header">
|
||
|
|
<div class="summary">
|
||
|
|
<a href="#pub-methods">Public Member Functions</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<h1>AP_VarI Class Reference</h1> </div>
|
||
|
|
</div>
|
||
|
|
<div class="contents">
|
||
|
|
<!-- doxytag: class="AP_VarI" -->
|
||
|
|
<p><code>#include <<a class="el" href="_a_p___var_8h_source.html">AP_Var.h</a>></code></p>
|
||
|
|
|
||
|
|
<p>Inherited by <a class="el" href="class_a_p___var.html">AP_Var< type ></a>.</p>
|
||
|
|
|
||
|
|
<p><a href="class_a_p___var_i-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">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___var_i.html#adfd663865a753f615f8b249b1426b54f">setF</a> (const float &val)=0</td></tr>
|
||
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the variable value as a float. <a href="#adfd663865a753f615f8b249b1426b54f"></a><br/></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual const float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___var_i.html#a1b50d86ffd0390c143341c014474a218">getF</a> ()=0</td></tr>
|
||
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the variable value as a float. <a href="#a1b50d86ffd0390c143341c014474a218"></a><br/></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___var_i.html#ab7c748c56e6e935f03579f4b116f50f9">setI</a> (const int16_t &val)=0</td></tr>
|
||
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the variable value as an int16. <a href="#ab7c748c56e6e935f03579f4b116f50f9"></a><br/></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual const int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___var_i.html#a78183ef519ef8e274df3cbd11f9f2b4f">getI</a> ()=0</td></tr>
|
||
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the variable value as an int16. <a href="#a78183ef519ef8e274df3cbd11f9f2b4f"></a><br/></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___var_i.html#a6ffa81fd83ca84a595f61bf39cc34216">setB</a> (const bool &val)=0</td></tr>
|
||
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the variable value as a bool. <a href="#a6ffa81fd83ca84a595f61bf39cc34216"></a><br/></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual const bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___var_i.html#aea62e6dea7e5be802558dcd51d3b8af1">getB</a> ()=0</td></tr>
|
||
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the variable value as an bool. <a href="#aea62e6dea7e5be802558dcd51d3b8af1"></a><br/></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___var_i.html#ae2354a7d4d8ce5d6c20bfd4ae301be89">save</a> ()=0</td></tr>
|
||
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save a variable to eeprom. <a href="#ae2354a7d4d8ce5d6c20bfd4ae301be89"></a><br/></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___var_i.html#ad50664746e42423d935bee72dd112e5f">load</a> ()=0</td></tr>
|
||
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load a variable from eeprom. <a href="#ad50664746e42423d935bee72dd112e5f"></a><br/></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___var_i.html#ab10f01cf0c912821f02c6da05558bd58">getName</a> ()=0</td></tr>
|
||
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name. This is useful for ground stations. <a href="#ab10f01cf0c912821f02c6da05558bd58"></a><br/></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual const bool & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___var_i.html#af00682586b63817dce7f6e6bc22e63cf">getSync</a> ()=0</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___var_i.html#a36f98257958da71376d7d7f032fe5da9">setSync</a> (const bool &sync)=0</td></tr>
|
||
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the sync property. <a href="#a36f98257958da71376d7d7f032fe5da9"></a><br/></td></tr>
|
||
|
|
</table>
|
||
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
||
|
|
<p>The AP variable interface. This allows different types of variables to be passed to blocks for floating point math, memory management, etc. </p>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="_a_p___var_8h_source.html#l00014">14</a> of file <a class="el" href="_a_p___var_8h_source.html">AP_Var.h</a>.</p>
|
||
|
|
<hr/><h2>Member Function Documentation</h2>
|
||
|
|
<a class="anchor" id="aea62e6dea7e5be802558dcd51d3b8af1"></a><!-- doxytag: member="AP_VarI::getB" ref="aea62e6dea7e5be802558dcd51d3b8af1" args="()=0" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual const bool AP_VarI::getB </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td><code> [pure virtual]</code></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get the variable value as an bool. </p>
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="class_a_p___var.html#a9f767d0605a0eaff9b7b07b539c2cfc9">AP_Var< type ></a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a1b50d86ffd0390c143341c014474a218"></a><!-- doxytag: member="AP_VarI::getF" ref="a1b50d86ffd0390c143341c014474a218" args="()=0" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual const float AP_VarI::getF </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td><code> [pure virtual]</code></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get the variable value as a float. </p>
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="class_a_p___var.html#adcc758d2c9fde9cadf7503ce39d9ed8e">AP_Var< type ></a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a78183ef519ef8e274df3cbd11f9f2b4f"></a><!-- doxytag: member="AP_VarI::getI" ref="a78183ef519ef8e274df3cbd11f9f2b4f" args="()=0" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual const int16_t AP_VarI::getI </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td><code> [pure virtual]</code></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get the variable value as an int16. </p>
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="class_a_p___var.html#aea52ce883edb2af3007e2c4f5c91dd71">AP_Var< type ></a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ab10f01cf0c912821f02c6da05558bd58"></a><!-- doxytag: member="AP_VarI::getName" ref="ab10f01cf0c912821f02c6da05558bd58" args="()=0" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual const char* AP_VarI::getName </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td><code> [pure virtual]</code></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get the name. This is useful for ground stations. </p>
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="class_a_p___var.html#a90ee0ac1b5c782c90573bb6ab80e6e99">AP_Var< type ></a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="af00682586b63817dce7f6e6bc22e63cf"></a><!-- doxytag: member="AP_VarI::getSync" ref="af00682586b63817dce7f6e6bc22e63cf" args="()=0" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual const bool& AP_VarI::getSync </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td><code> [pure virtual]</code></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>If sync is true the a load will always occure before a get and a save will always occure before a set. </p>
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="class_a_p___var.html#af5769a3f429bd4453e2ac725a6857a07">AP_Var< type ></a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ad50664746e42423d935bee72dd112e5f"></a><!-- doxytag: member="AP_VarI::load" ref="ad50664746e42423d935bee72dd112e5f" args="()=0" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual void AP_VarI::load </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td><code> [pure virtual]</code></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>Load a variable from eeprom. </p>
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="class_a_p___var.html#aa885a4c96d6e7b099bde8bde5669e407">AP_Var< type ></a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ae2354a7d4d8ce5d6c20bfd4ae301be89"></a><!-- doxytag: member="AP_VarI::save" ref="ae2354a7d4d8ce5d6c20bfd4ae301be89" args="()=0" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual void AP_VarI::save </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td><code> [pure virtual]</code></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>Save a variable to eeprom. </p>
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="class_a_p___var.html#afa88a5ff01e70d17529c683016d62456">AP_Var< type ></a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a6ffa81fd83ca84a595f61bf39cc34216"></a><!-- doxytag: member="AP_VarI::setB" ref="a6ffa81fd83ca84a595f61bf39cc34216" args="(const bool &val)=0" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual void AP_VarI::setB </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const bool & </td>
|
||
|
|
<td class="paramname"> <em>val</em></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td><code> [pure virtual]</code></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>Set the variable value as a bool. </p>
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="class_a_p___var.html#aea7699e11298a8f24b2583aa59de5825">AP_Var< type ></a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="adfd663865a753f615f8b249b1426b54f"></a><!-- doxytag: member="AP_VarI::setF" ref="adfd663865a753f615f8b249b1426b54f" args="(const float &val)=0" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual void AP_VarI::setF </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const float & </td>
|
||
|
|
<td class="paramname"> <em>val</em></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td><code> [pure virtual]</code></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>Set the variable value as a float. </p>
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="class_a_p___var.html#ae67a45d5b0ab1b2156e67635d39574ed">AP_Var< type ></a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ab7c748c56e6e935f03579f4b116f50f9"></a><!-- doxytag: member="AP_VarI::setI" ref="ab7c748c56e6e935f03579f4b116f50f9" args="(const int16_t &val)=0" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual void AP_VarI::setI </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const int16_t & </td>
|
||
|
|
<td class="paramname"> <em>val</em></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td><code> [pure virtual]</code></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>Set the variable value as an int16. </p>
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="class_a_p___var.html#adca33b6152a1de871cb76e299a4f3844">AP_Var< type ></a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a36f98257958da71376d7d7f032fe5da9"></a><!-- doxytag: member="AP_VarI::setSync" ref="a36f98257958da71376d7d7f032fe5da9" args="(const bool &sync)=0" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual void AP_VarI::setSync </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const bool & </td>
|
||
|
|
<td class="paramname"> <em>sync</em></td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td><code> [pure virtual]</code></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>Set the sync property. </p>
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="class_a_p___var.html#a7ceaa4b6b2ccdc08d65b114bb00c2db5">AP_Var< type ></a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
||
|
|
<li><a class="el" href="_a_p___var_8h_source.html">AP_Var.h</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<hr class="footer"/><address class="footer"><small>
|
||
|
|
Generated for ArduPilot Libraries by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.png" alt="doxygen"/></a></small></address>
|
||
|
|
</body>
|
||
|
|
</html>
|