deploy: BluEye-Robotics/libblunux@63c3d6e

_i_observer_state_8hpp_source.html

@@ -115,9 +115,11 @@
 <div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span>  <span class="keyword">virtual</span> Eigen::Vector3d getAccData(<span class="keywordtype">int</span> num) <span class="keyword">const</span> = 0;</div>
 <div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span> </div>
 <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="classblunux_1_1observer_1_1_i_observer_state.html#a2a7715aff52999b3b8a25c58856a8bc1">   70</a></span>  <span class="keyword">virtual</span> InitialMotionState <a class="code hl_function" href="classblunux_1_1observer_1_1_i_observer_state.html#a2a7715aff52999b3b8a25c58856a8bc1">getInitialMotionState</a>() <span class="keyword">const</span> = 0;</div>
-<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span>};</div>
+<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span> </div>
+<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="classblunux_1_1observer_1_1_i_observer_state.html#af96ff2d1468c2c700bdc09ccd8e2aa08">   77</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classblunux_1_1observer_1_1_i_observer_state.html#af96ff2d1468c2c700bdc09ccd8e2aa08">isCompassFullCalibrationValid</a>() <span class="keyword">const</span> = 0;</div>
+<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span>};</div>
 </div>
-<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span>}  <span class="comment">// namespace blunux::observer</span></div>
+<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span>}  <span class="comment">// namespace blunux::observer</span></div>
 <div class="ttc" id="aclassblunux_1_1observer_1_1_i_observer_state_html"><div class="ttname"><a href="classblunux_1_1observer_1_1_i_observer_state.html">blunux::observer::IObserverState</a></div><div class="ttdoc">Interface for observing the state of a system.</div><div class="ttdef"><b>Definition</b> IObserverState.hpp:14</div></div>
 <div class="ttc" id="aclassblunux_1_1observer_1_1_i_observer_state_html_a03d0e804220f917cfe8b46fb7c181439"><div class="ttname"><a href="classblunux_1_1observer_1_1_i_observer_state.html#a03d0e804220f917cfe8b46fb7c181439">blunux::observer::IObserverState::getGlobalalOrientationAxis</a></div><div class="ttdeci">virtual Eigen::Vector3d getGlobalalOrientationAxis() const =0</div><div class="ttdoc">Get the global orientation axis.</div></div>
 <div class="ttc" id="aclassblunux_1_1observer_1_1_i_observer_state_html_a10b5fdae4c0ed07c2b054c531d55269f"><div class="ttname"><a href="classblunux_1_1observer_1_1_i_observer_state.html#a10b5fdae4c0ed07c2b054c531d55269f">blunux::observer::IObserverState::getLocalAttitudeEuler</a></div><div class="ttdeci">virtual Eigen::Vector3d getLocalAttitudeEuler() const =0</div><div class="ttdoc">Get the local attitude in Euler angles.</div></div>
@@ -126,6 +128,7 @@
 <div class="ttc" id="aclassblunux_1_1observer_1_1_i_observer_state_html_ab20b6eac9cd076940d1aaae558a541f1"><div class="ttname"><a href="classblunux_1_1observer_1_1_i_observer_state.html#ab20b6eac9cd076940d1aaae558a541f1">blunux::observer::IObserverState::getGlobalAttitudeEuler</a></div><div class="ttdeci">virtual Eigen::Vector3d getGlobalAttitudeEuler() const =0</div><div class="ttdoc">Get the global attitude in Euler angles.</div></div>
 <div class="ttc" id="aclassblunux_1_1observer_1_1_i_observer_state_html_ad01739ca7fff75fcad8fa65271e46b5c"><div class="ttname"><a href="classblunux_1_1observer_1_1_i_observer_state.html#ad01739ca7fff75fcad8fa65271e46b5c">blunux::observer::IObserverState::getGlobalHeading</a></div><div class="ttdeci">virtual double getGlobalHeading() const =0</div><div class="ttdoc">Get the global heading angle.</div></div>
 <div class="ttc" id="aclassblunux_1_1observer_1_1_i_observer_state_html_af525148a6eb65490f8e8ae742e40780b"><div class="ttname"><a href="classblunux_1_1observer_1_1_i_observer_state.html#af525148a6eb65490f8e8ae742e40780b">blunux::observer::IObserverState::getStateEstimates</a></div><div class="ttdeci">virtual StateEstimates getStateEstimates() const =0</div><div class="ttdoc">Get state estimates.</div></div>
+<div class="ttc" id="aclassblunux_1_1observer_1_1_i_observer_state_html_af96ff2d1468c2c700bdc09ccd8e2aa08"><div class="ttname"><a href="classblunux_1_1observer_1_1_i_observer_state.html#af96ff2d1468c2c700bdc09ccd8e2aa08">blunux::observer::IObserverState::isCompassFullCalibrationValid</a></div><div class="ttdeci">virtual bool isCompassFullCalibrationValid() const =0</div><div class="ttdoc">Check if the calibration is valid.</div></div>
 <div class="ttc" id="astructblunux_1_1imu_1_1_imu_data_html"><div class="ttname"><a href="structblunux_1_1imu_1_1_imu_data.html">blunux::imu::ImuData</a></div><div class="ttdoc">Structure representing IMU data.</div><div class="ttdef"><b>Definition</b> ImuData.hpp:13</div></div>
 <div class="ttc" id="astructblunux_1_1observer_1_1_state_estimates_html"><div class="ttname"><a href="structblunux_1_1observer_1_1_state_estimates.html">blunux::observer::StateEstimates</a></div><div class="ttdoc">Structure representing state estimates.</div><div class="ttdef"><b>Definition</b> StateEstimates.hpp:7</div></div>
 </div><!-- fragment --></div><!-- contents -->

classblunux_1_1observer_1_1_i_observer_state-members.html

@@ -91,6 +91,7 @@
   <tr class="odd"><td class="entry"><a class="el" href="classblunux_1_1observer_1_1_i_observer_state.html#a10b5fdae4c0ed07c2b054c531d55269f">getLocalAttitudeEuler</a>() const =0</td><td class="entry"><a class="el" href="classblunux_1_1observer_1_1_i_observer_state.html">blunux::observer::IObserverState</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classblunux_1_1observer_1_1_i_observer_state.html#a5deae45623df2da7fa3b571d81a8dcd2">getLocalOrientationAxis</a>() const =0</td><td class="entry"><a class="el" href="classblunux_1_1observer_1_1_i_observer_state.html">blunux::observer::IObserverState</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classblunux_1_1observer_1_1_i_observer_state.html#af525148a6eb65490f8e8ae742e40780b">getStateEstimates</a>() const =0</td><td class="entry"><a class="el" href="classblunux_1_1observer_1_1_i_observer_state.html">blunux::observer::IObserverState</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classblunux_1_1observer_1_1_i_observer_state.html#af96ff2d1468c2c700bdc09ccd8e2aa08">isCompassFullCalibrationValid</a>() const =0</td><td class="entry"><a class="el" href="classblunux_1_1observer_1_1_i_observer_state.html">blunux::observer::IObserverState</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
 </table></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>

classblunux_1_1observer_1_1_i_observer_state.html

@@ -123,6 +123,9 @@
 <tr class="memitem:a2a7715aff52999b3b8a25c58856a8bc1" id="r_a2a7715aff52999b3b8a25c58856a8bc1"><td class="memItemLeft" align="right" valign="top">virtual InitialMotionState&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblunux_1_1observer_1_1_i_observer_state.html#a2a7715aff52999b3b8a25c58856a8bc1">getInitialMotionState</a> () const =0</td></tr>
 <tr class="memdesc:a2a7715aff52999b3b8a25c58856a8bc1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the drone is stationary since boot.  <br /></td></tr>
 <tr class="separator:a2a7715aff52999b3b8a25c58856a8bc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:af96ff2d1468c2c700bdc09ccd8e2aa08" id="r_af96ff2d1468c2c700bdc09ccd8e2aa08"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblunux_1_1observer_1_1_i_observer_state.html#af96ff2d1468c2c700bdc09ccd8e2aa08">isCompassFullCalibrationValid</a> () const =0</td></tr>
+<tr class="memdesc:af96ff2d1468c2c700bdc09ccd8e2aa08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the calibration is valid.  <br /></td></tr>
+<tr class="separator:af96ff2d1468c2c700bdc09ccd8e2aa08"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>Interface for observing the state of a system. </p>
@@ -322,6 +325,34 @@ <h2 class="memtitle"><span class="permalink"><a href="#af525148a6eb65490f8e8ae74
 <p>Get state estimates. </p>
 <dl class="section return"><dt>Returns</dt><dd>State estimates including depth, depth rate, surface level, heading, and yaw rate. </dd></dl>
 
+</div>
+</div>
+<a id="af96ff2d1468c2c700bdc09ccd8e2aa08" name="af96ff2d1468c2c700bdc09ccd8e2aa08"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#af96ff2d1468c2c700bdc09ccd8e2aa08">&#9670;&#160;</a></span>isCompassFullCalibrationValid()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual bool blunux::observer::IObserverState::isCompassFullCalibrationValid </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td> const</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Check if the calibration is valid. </p>
+<dl class="section return"><dt>Returns</dt><dd>bool true if the calibration is valid </dd></dl>
+
 </div>
 </div>
 <hr/>The documentation for this class was generated from the following file:<ul>

functions.html

@@ -145,6 +145,7 @@ <h3><a id="index_i" name="index_i"></a>- i -</h3><ul>
 <li>is_stabilized()&#160;:&#160;<a class="el" href="classblunux_1_1tilt_1_1_i_tilt_control.html#a02737f13470b1a6c98b822c6f0d94ef4">blunux::tilt::ITiltControl</a></li>
 <li>isCalibrating()&#160;:&#160;<a class="el" href="classblunux_1_1observer_1_1_i_compass_calibration.html#a4ef5ee091c49e891628586fd5e934da7">blunux::observer::ICompassCalibration</a></li>
 <li>isCalibrationFinished()&#160;:&#160;<a class="el" href="classblunux_1_1observer_1_1_i_compass_calibration.html#a722f5e9abc272546927afd340c3ef2f2">blunux::observer::ICompassCalibration</a></li>
+<li>isCompassFullCalibrationValid()&#160;:&#160;<a class="el" href="classblunux_1_1observer_1_1_i_observer_state.html#af96ff2d1468c2c700bdc09ccd8e2aa08">blunux::observer::IObserverState</a></li>
 <li>isReadyForThrusterCalibration()&#160;:&#160;<a class="el" href="classblunux_1_1observer_1_1_i_compass_calibration.html#a575a7391ec9c17538702f2ba559f4584">blunux::observer::ICompassCalibration</a></li>
 </ul>
 

functions_func.html

@@ -126,6 +126,7 @@ <h3><a id="index_i" name="index_i"></a>- i -</h3><ul>
 <li>is_stabilized()&#160;:&#160;<a class="el" href="classblunux_1_1tilt_1_1_i_tilt_control.html#a02737f13470b1a6c98b822c6f0d94ef4">blunux::tilt::ITiltControl</a></li>
 <li>isCalibrating()&#160;:&#160;<a class="el" href="classblunux_1_1observer_1_1_i_compass_calibration.html#a4ef5ee091c49e891628586fd5e934da7">blunux::observer::ICompassCalibration</a></li>
 <li>isCalibrationFinished()&#160;:&#160;<a class="el" href="classblunux_1_1observer_1_1_i_compass_calibration.html#a722f5e9abc272546927afd340c3ef2f2">blunux::observer::ICompassCalibration</a></li>
+<li>isCompassFullCalibrationValid()&#160;:&#160;<a class="el" href="classblunux_1_1observer_1_1_i_observer_state.html#af96ff2d1468c2c700bdc09ccd8e2aa08">blunux::observer::IObserverState</a></li>
 <li>isReadyForThrusterCalibration()&#160;:&#160;<a class="el" href="classblunux_1_1observer_1_1_i_compass_calibration.html#a575a7391ec9c17538702f2ba559f4584">blunux::observer::ICompassCalibration</a></li>
 </ul>