qtrocket2/docs/doxygen/html/FlightState_8h_source.html

185 lines
21 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QtRocket: include/FlightState.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">QtRocket
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('FlightState_8h_source.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">FlightState.h</div></div>
</div><!--header-->
<div class="contents">
<a href="FlightState_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef FLIGHTSTATE_H</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define FLIGHTSTATE_H</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;array&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span></div>
<div class="foldopen" id="foldopen00012" data-start="{" data-end="};">
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="classFlightState.html"> 12</a></span><span class="keyword">class </span><a class="code hl_function" href="classFlightState.html#a0ad4506495a7c369e5448db568b95148">FlightState</a> {</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <a class="code hl_function" href="classFlightState.html#a0ad4506495a7c369e5448db568b95148">FlightState</a>();</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">const</span> std::array&lt;double, 3&gt;&amp; <a class="code hl_function" href="classFlightState.html#a9a1183505e6539073cb6f3ff5fcc505b">getPosition</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classFlightState.html#a5cbeb7d04ea884baeb09579a3d5909fc">setPosition</a>(<span class="keyword">const</span> std::array&lt;double, 3&gt;&amp; pos);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">const</span> std::array&lt;double, 3&gt;&amp; <a class="code hl_function" href="classFlightState.html#ad78ea9399327e70496f3508f2a1ffb1f">getVelocity</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classFlightState.html#a2f127e65b737842f0fcd0083c8d5eb4a">setVelocity</a>(<span class="keyword">const</span> std::array&lt;double, 3&gt;&amp; vel);</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">const</span> std::array&lt;double, 3&gt;&amp; <a class="code hl_function" href="classFlightState.html#a128d86980e2ef1659698d59020c3f553">getAcceleration</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classFlightState.html#afcd8ae883f3892ccbac685b56dcdbaaa">setAcceleration</a>(<span class="keyword">const</span> std::array&lt;double, 3&gt;&amp; acc);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">const</span> std::array&lt;double, 4&gt;&amp; <a class="code hl_function" href="classFlightState.html#a1f862a9bb17f314c0651af79766319be">getOrientation</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classFlightState.html#a0b464e9d452d4bf846b626a18834a717">setOrientation</a>(<span class="keyword">const</span> std::array&lt;double, 4&gt;&amp; quat);</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">const</span> std::array&lt;double, 3&gt;&amp; <a class="code hl_function" href="classFlightState.html#aea387dd379deb54afe103ddc938a5f7f">getAngularVelocity</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classFlightState.html#a48a0e6c28bb2df12adf06fb33a789261">setAngularVelocity</a>(<span class="keyword">const</span> std::array&lt;double, 3&gt;&amp; angVel);</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classFlightState.html#ada75d863cd3ea7f93bdca37920379d15">getTime</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classFlightState.html#af4c9e070d86dde642c2f4a7d63ff41aa">setTime</a>(<span class="keywordtype">double</span> time);</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="classFlightState.html#afbb03ba494744fa4a3e6aad53f4f7f12"> 92</a></span> std::array&lt;double, 3&gt; <a class="code hl_variable" href="classFlightState.html#afbb03ba494744fa4a3e6aad53f4f7f12">position_</a>; </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="classFlightState.html#acc04fd99d58fa385c9e0589e6928989b"> 93</a></span> std::array&lt;double, 3&gt; <a class="code hl_variable" href="classFlightState.html#acc04fd99d58fa385c9e0589e6928989b">velocity_</a>; </div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="classFlightState.html#a4a25219c824f6299b28ac37a940a4b7c"> 94</a></span> std::array&lt;double, 3&gt; <a class="code hl_variable" href="classFlightState.html#a4a25219c824f6299b28ac37a940a4b7c">acceleration_</a>; </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="classFlightState.html#a55d84aa9142d7e766e778787423af89a"> 96</a></span> std::array&lt;double, 4&gt; <a class="code hl_variable" href="classFlightState.html#a55d84aa9142d7e766e778787423af89a">orientation_</a>; </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="classFlightState.html#a5b1dcec1739e2dcf4c2f01f98291b68f"> 97</a></span> std::array&lt;double, 3&gt; <a class="code hl_variable" href="classFlightState.html#a5b1dcec1739e2dcf4c2f01f98291b68f">angularVelocity_</a>; </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="classFlightState.html#a527ffdbb2decbf80e147b161dbdff374"> 99</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="classFlightState.html#a527ffdbb2decbf80e147b161dbdff374">time_</a>; </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span>};</div>
</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="preprocessor">#endif </span><span class="comment">// FLIGHTSTATE_H</span></div>
<div class="ttc" id="aclassFlightState_html_a0ad4506495a7c369e5448db568b95148"><div class="ttname"><a href="classFlightState.html#a0ad4506495a7c369e5448db568b95148">FlightState::FlightState</a></div><div class="ttdeci">FlightState()</div><div class="ttdoc">Default constructor. Initializes to zero state.</div><div class="ttdef"><b>Definition</b> FlightState.cpp:6</div></div>
<div class="ttc" id="aclassFlightState_html_a0b464e9d452d4bf846b626a18834a717"><div class="ttname"><a href="classFlightState.html#a0b464e9d452d4bf846b626a18834a717">FlightState::setOrientation</a></div><div class="ttdeci">void setOrientation(const std::array&lt; double, 4 &gt; &amp;quat)</div><div class="ttdoc">Sets the current orientation quaternion.</div><div class="ttdef"><b>Definition</b> FlightState.cpp:45</div></div>
<div class="ttc" id="aclassFlightState_html_a128d86980e2ef1659698d59020c3f553"><div class="ttname"><a href="classFlightState.html#a128d86980e2ef1659698d59020c3f553">FlightState::getAcceleration</a></div><div class="ttdeci">const std::array&lt; double, 3 &gt; &amp; getAcceleration() const</div><div class="ttdoc">Gets the current acceleration vector.</div><div class="ttdef"><b>Definition</b> FlightState.cpp:33</div></div>
<div class="ttc" id="aclassFlightState_html_a1f862a9bb17f314c0651af79766319be"><div class="ttname"><a href="classFlightState.html#a1f862a9bb17f314c0651af79766319be">FlightState::getOrientation</a></div><div class="ttdeci">const std::array&lt; double, 4 &gt; &amp; getOrientation() const</div><div class="ttdoc">Gets the current orientation quaternion.</div><div class="ttdef"><b>Definition</b> FlightState.cpp:41</div></div>
<div class="ttc" id="aclassFlightState_html_a2f127e65b737842f0fcd0083c8d5eb4a"><div class="ttname"><a href="classFlightState.html#a2f127e65b737842f0fcd0083c8d5eb4a">FlightState::setVelocity</a></div><div class="ttdeci">void setVelocity(const std::array&lt; double, 3 &gt; &amp;vel)</div><div class="ttdoc">Sets the current velocity vector.</div><div class="ttdef"><b>Definition</b> FlightState.cpp:29</div></div>
<div class="ttc" id="aclassFlightState_html_a48a0e6c28bb2df12adf06fb33a789261"><div class="ttname"><a href="classFlightState.html#a48a0e6c28bb2df12adf06fb33a789261">FlightState::setAngularVelocity</a></div><div class="ttdeci">void setAngularVelocity(const std::array&lt; double, 3 &gt; &amp;angVel)</div><div class="ttdoc">Sets the current angular velocity vector.</div><div class="ttdef"><b>Definition</b> FlightState.cpp:53</div></div>
<div class="ttc" id="aclassFlightState_html_a4a25219c824f6299b28ac37a940a4b7c"><div class="ttname"><a href="classFlightState.html#a4a25219c824f6299b28ac37a940a4b7c">FlightState::acceleration_</a></div><div class="ttdeci">std::array&lt; double, 3 &gt; acceleration_</div><div class="ttdoc">(ax, ay, az) acceleration in m/s2.</div><div class="ttdef"><b>Definition</b> FlightState.h:94</div></div>
<div class="ttc" id="aclassFlightState_html_a527ffdbb2decbf80e147b161dbdff374"><div class="ttname"><a href="classFlightState.html#a527ffdbb2decbf80e147b161dbdff374">FlightState::time_</a></div><div class="ttdeci">double time_</div><div class="ttdoc">Elapsed simulation time [s].</div><div class="ttdef"><b>Definition</b> FlightState.h:99</div></div>
<div class="ttc" id="aclassFlightState_html_a55d84aa9142d7e766e778787423af89a"><div class="ttname"><a href="classFlightState.html#a55d84aa9142d7e766e778787423af89a">FlightState::orientation_</a></div><div class="ttdeci">std::array&lt; double, 4 &gt; orientation_</div><div class="ttdoc">Orientation quaternion (w, x, y, z).</div><div class="ttdef"><b>Definition</b> FlightState.h:96</div></div>
<div class="ttc" id="aclassFlightState_html_a5b1dcec1739e2dcf4c2f01f98291b68f"><div class="ttname"><a href="classFlightState.html#a5b1dcec1739e2dcf4c2f01f98291b68f">FlightState::angularVelocity_</a></div><div class="ttdeci">std::array&lt; double, 3 &gt; angularVelocity_</div><div class="ttdoc">Angular rates (roll, pitch, yaw) in rad/s.</div><div class="ttdef"><b>Definition</b> FlightState.h:97</div></div>
<div class="ttc" id="aclassFlightState_html_a5cbeb7d04ea884baeb09579a3d5909fc"><div class="ttname"><a href="classFlightState.html#a5cbeb7d04ea884baeb09579a3d5909fc">FlightState::setPosition</a></div><div class="ttdeci">void setPosition(const std::array&lt; double, 3 &gt; &amp;pos)</div><div class="ttdoc">Sets the current position vector.</div><div class="ttdef"><b>Definition</b> FlightState.cpp:21</div></div>
<div class="ttc" id="aclassFlightState_html_a9a1183505e6539073cb6f3ff5fcc505b"><div class="ttname"><a href="classFlightState.html#a9a1183505e6539073cb6f3ff5fcc505b">FlightState::getPosition</a></div><div class="ttdeci">const std::array&lt; double, 3 &gt; &amp; getPosition() const</div><div class="ttdoc">Gets the current position vector.</div><div class="ttdef"><b>Definition</b> FlightState.cpp:17</div></div>
<div class="ttc" id="aclassFlightState_html_acc04fd99d58fa385c9e0589e6928989b"><div class="ttname"><a href="classFlightState.html#acc04fd99d58fa385c9e0589e6928989b">FlightState::velocity_</a></div><div class="ttdeci">std::array&lt; double, 3 &gt; velocity_</div><div class="ttdoc">(vx, vy, vz) velocity in m/s.</div><div class="ttdef"><b>Definition</b> FlightState.h:93</div></div>
<div class="ttc" id="aclassFlightState_html_ad78ea9399327e70496f3508f2a1ffb1f"><div class="ttname"><a href="classFlightState.html#ad78ea9399327e70496f3508f2a1ffb1f">FlightState::getVelocity</a></div><div class="ttdeci">const std::array&lt; double, 3 &gt; &amp; getVelocity() const</div><div class="ttdoc">Gets the current velocity vector.</div><div class="ttdef"><b>Definition</b> FlightState.cpp:25</div></div>
<div class="ttc" id="aclassFlightState_html_ada75d863cd3ea7f93bdca37920379d15"><div class="ttname"><a href="classFlightState.html#ada75d863cd3ea7f93bdca37920379d15">FlightState::getTime</a></div><div class="ttdeci">double getTime() const</div><div class="ttdoc">Gets the elapsed simulation time.</div><div class="ttdef"><b>Definition</b> FlightState.cpp:57</div></div>
<div class="ttc" id="aclassFlightState_html_aea387dd379deb54afe103ddc938a5f7f"><div class="ttname"><a href="classFlightState.html#aea387dd379deb54afe103ddc938a5f7f">FlightState::getAngularVelocity</a></div><div class="ttdeci">const std::array&lt; double, 3 &gt; &amp; getAngularVelocity() const</div><div class="ttdoc">Gets the current angular velocity vector.</div><div class="ttdef"><b>Definition</b> FlightState.cpp:49</div></div>
<div class="ttc" id="aclassFlightState_html_af4c9e070d86dde642c2f4a7d63ff41aa"><div class="ttname"><a href="classFlightState.html#af4c9e070d86dde642c2f4a7d63ff41aa">FlightState::setTime</a></div><div class="ttdeci">void setTime(double time)</div><div class="ttdoc">Sets the elapsed simulation time.</div><div class="ttdef"><b>Definition</b> FlightState.cpp:61</div></div>
<div class="ttc" id="aclassFlightState_html_afbb03ba494744fa4a3e6aad53f4f7f12"><div class="ttname"><a href="classFlightState.html#afbb03ba494744fa4a3e6aad53f4f7f12">FlightState::position_</a></div><div class="ttdeci">std::array&lt; double, 3 &gt; position_</div><div class="ttdoc">(x, y, z) position in meters.</div><div class="ttdef"><b>Definition</b> FlightState.h:92</div></div>
<div class="ttc" id="aclassFlightState_html_afcd8ae883f3892ccbac685b56dcdbaaa"><div class="ttname"><a href="classFlightState.html#afcd8ae883f3892ccbac685b56dcdbaaa">FlightState::setAcceleration</a></div><div class="ttdeci">void setAcceleration(const std::array&lt; double, 3 &gt; &amp;acc)</div><div class="ttdoc">Sets the current acceleration vector.</div><div class="ttdef"><b>Definition</b> FlightState.cpp:37</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="FlightState_8h.html">FlightState.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
</ul>
</div>
</body>
</html>