travis/qtrocket2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
qtrocket2/docs/doxygen/html/RecoverySystem_8h_source.html

187 lines
21 KiB
HTML
Raw Permalink Blame History

<!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/RecoverySystem.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('RecoverySystem_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">RecoverySystem.h</div></div>
</div><!--header-->
<div class="contents">
<a href="RecoverySystem_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 RECOVERYSYSTEM_H</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define RECOVERYSYSTEM_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;string&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="classRecoverySystem.html"> 12</a></span><span class="keyword">class </span><a class="code hl_function" href="classRecoverySystem.html#ae51984e16fe7cf50197fd8fa95a73b7a">RecoverySystem</a> {</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">public</span>:</div>
<div class="foldopen" id="foldopen00017" data-start="{" data-end="};">
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classRecoverySystem.html#a1efb5b07db1791eac5714825837a76d8"> 17</a></span> <span class="keyword">enum class</span> <a class="code hl_enumeration" href="classRecoverySystem.html#a1efb5b07db1791eac5714825837a76d8">DeploymentType</a> {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="classRecoverySystem.html#a1efb5b07db1791eac5714825837a76d8a40bea05699cf5192813d9535f3e527ca"> 18</a></span> <a class="code hl_enumvalue" href="classRecoverySystem.html#a1efb5b07db1791eac5714825837a76d8a40bea05699cf5192813d9535f3e527ca">Apogee</a>,</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="classRecoverySystem.html#a1efb5b07db1791eac5714825837a76d8a613a3d4fa7b8e2538d1e559cbd572902"> 19</a></span> <a class="code hl_enumvalue" href="classRecoverySystem.html#a1efb5b07db1791eac5714825837a76d8a613a3d4fa7b8e2538d1e559cbd572902">Altitude</a>,</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="classRecoverySystem.html#a1efb5b07db1791eac5714825837a76d8aefb4777327e6f704fb1519c1882f93ec"> 20</a></span> <a class="code hl_enumvalue" href="classRecoverySystem.html#a1efb5b07db1791eac5714825837a76d8aefb4777327e6f704fb1519c1882f93ec">Timer</a></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> };</div>
</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <a class="code hl_function" href="classRecoverySystem.html#ae51984e16fe7cf50197fd8fa95a73b7a">RecoverySystem</a>(<span class="keyword">const</span> std::string&amp; name,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <a class="code hl_enumeration" href="classRecoverySystem.html#a1efb5b07db1791eac5714825837a76d8">DeploymentType</a> deploymentType,</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordtype">double</span> triggerValue,</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordtype">double</span> dragCoefficient,</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">double</span> referenceArea);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="classRecoverySystem.html#a7e6f3b43e3bc783b0187e16209732894"> 40</a></span> <a class="code hl_function" href="classRecoverySystem.html#a7e6f3b43e3bc783b0187e16209732894">~RecoverySystem</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classRecoverySystem.html#a71620d51b6ed4a1c240b8267e04a6930">checkDeploymentCondition</a>(<span class="keywordtype">double</span> altitude, <span class="keywordtype">double</span> velocity, <span class="keywordtype">double</span> time, <span class="keywordtype">bool</span> atApogee) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classRecoverySystem.html#a62619dd8617adcd5dbc373c97e9ed1ca">deploy</a>();</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classRecoverySystem.html#aef0d9ece48e151e102905459c131a443">isDeployed</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classRecoverySystem.html#ab4db28b4ab611843003e9d6aa72b6aaf">getDragCoefficient</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classRecoverySystem.html#aee891188c06da83c0460b9a01cf6e2bd">getReferenceArea</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">const</span> std::string&amp; <a class="code hl_function" href="classRecoverySystem.html#a2bd6e22f2812d63556150eb44bbee811">getName</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="classRecoverySystem.html#a8494f4586809c22f0537c708dba74615"> 82</a></span> std::string <a class="code hl_variable" href="classRecoverySystem.html#a8494f4586809c22f0537c708dba74615">name_</a>; </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="classRecoverySystem.html#af31cabfef9286683d4b5218b125a86bf"> 84</a></span> <a class="code hl_enumeration" href="classRecoverySystem.html#a1efb5b07db1791eac5714825837a76d8">DeploymentType</a> <a class="code hl_variable" href="classRecoverySystem.html#af31cabfef9286683d4b5218b125a86bf">deploymentType_</a>; </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="classRecoverySystem.html#af9de6ddcd7f233d24a9bacd30549c8a3"> 85</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="classRecoverySystem.html#af9de6ddcd7f233d24a9bacd30549c8a3">triggerValue_</a>; </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="classRecoverySystem.html#abb0592632355b8102178b4814096560a"> 87</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="classRecoverySystem.html#abb0592632355b8102178b4814096560a">dragCoefficient_</a>; </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="classRecoverySystem.html#aceed5eea3e65b3b1719b079f974339e9"> 88</a></span> <span class="keywordtype">double</span> <a class="code hl_variable" href="classRecoverySystem.html#aceed5eea3e65b3b1719b079f974339e9">referenceArea_</a>; </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="classRecoverySystem.html#aa29f96ae8aa0f11f775974b8a862e02f"> 90</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classRecoverySystem.html#aa29f96ae8aa0f11f775974b8a862e02f">deployed_</a>; </div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span>};</div>
</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="preprocessor">#endif </span><span class="comment">// RECOVERYSYSTEM_H</span></div>
<div class="ttc" id="aclassRecoverySystem_html_a1efb5b07db1791eac5714825837a76d8"><div class="ttname"><a href="classRecoverySystem.html#a1efb5b07db1791eac5714825837a76d8">RecoverySystem::DeploymentType</a></div><div class="ttdeci">DeploymentType</div><div class="ttdoc">Deployment trigger types.</div><div class="ttdef"><b>Definition</b> RecoverySystem.h:17</div></div>
<div class="ttc" id="aclassRecoverySystem_html_a1efb5b07db1791eac5714825837a76d8a40bea05699cf5192813d9535f3e527ca"><div class="ttname"><a href="classRecoverySystem.html#a1efb5b07db1791eac5714825837a76d8a40bea05699cf5192813d9535f3e527ca">RecoverySystem::DeploymentType::Apogee</a></div><div class="ttdeci">@ Apogee</div><div class="ttdef"><b>Definition</b> RecoverySystem.h:18</div></div>
<div class="ttc" id="aclassRecoverySystem_html_a1efb5b07db1791eac5714825837a76d8a613a3d4fa7b8e2538d1e559cbd572902"><div class="ttname"><a href="classRecoverySystem.html#a1efb5b07db1791eac5714825837a76d8a613a3d4fa7b8e2538d1e559cbd572902">RecoverySystem::DeploymentType::Altitude</a></div><div class="ttdeci">@ Altitude</div><div class="ttdef"><b>Definition</b> RecoverySystem.h:19</div></div>
<div class="ttc" id="aclassRecoverySystem_html_a1efb5b07db1791eac5714825837a76d8aefb4777327e6f704fb1519c1882f93ec"><div class="ttname"><a href="classRecoverySystem.html#a1efb5b07db1791eac5714825837a76d8aefb4777327e6f704fb1519c1882f93ec">RecoverySystem::DeploymentType::Timer</a></div><div class="ttdeci">@ Timer</div><div class="ttdef"><b>Definition</b> RecoverySystem.h:20</div></div>
<div class="ttc" id="aclassRecoverySystem_html_a2bd6e22f2812d63556150eb44bbee811"><div class="ttname"><a href="classRecoverySystem.html#a2bd6e22f2812d63556150eb44bbee811">RecoverySystem::getName</a></div><div class="ttdeci">const std::string &amp; getName() const</div><div class="ttdoc">Gets the name of the recovery system.</div><div class="ttdef"><b>Definition</b> RecoverySystem.cpp:60</div></div>
<div class="ttc" id="aclassRecoverySystem_html_a62619dd8617adcd5dbc373c97e9ed1ca"><div class="ttname"><a href="classRecoverySystem.html#a62619dd8617adcd5dbc373c97e9ed1ca">RecoverySystem::deploy</a></div><div class="ttdeci">void deploy()</div><div class="ttdoc">Marks the recovery system as deployed.</div><div class="ttdef"><b>Definition</b> RecoverySystem.cpp:44</div></div>
<div class="ttc" id="aclassRecoverySystem_html_a71620d51b6ed4a1c240b8267e04a6930"><div class="ttname"><a href="classRecoverySystem.html#a71620d51b6ed4a1c240b8267e04a6930">RecoverySystem::checkDeploymentCondition</a></div><div class="ttdeci">bool checkDeploymentCondition(double altitude, double velocity, double time, bool atApogee) const</div><div class="ttdoc">Checks if deployment conditions are met based on flight state.</div><div class="ttdef"><b>Definition</b> RecoverySystem.cpp:21</div></div>
<div class="ttc" id="aclassRecoverySystem_html_a7e6f3b43e3bc783b0187e16209732894"><div class="ttname"><a href="classRecoverySystem.html#a7e6f3b43e3bc783b0187e16209732894">RecoverySystem::~RecoverySystem</a></div><div class="ttdeci">~RecoverySystem()=default</div><div class="ttdoc">Default destructor.</div></div>
<div class="ttc" id="aclassRecoverySystem_html_a8494f4586809c22f0537c708dba74615"><div class="ttname"><a href="classRecoverySystem.html#a8494f4586809c22f0537c708dba74615">RecoverySystem::name_</a></div><div class="ttdeci">std::string name_</div><div class="ttdoc">Name of the recovery system.</div><div class="ttdef"><b>Definition</b> RecoverySystem.h:82</div></div>
<div class="ttc" id="aclassRecoverySystem_html_aa29f96ae8aa0f11f775974b8a862e02f"><div class="ttname"><a href="classRecoverySystem.html#aa29f96ae8aa0f11f775974b8a862e02f">RecoverySystem::deployed_</a></div><div class="ttdeci">bool deployed_</div><div class="ttdoc">Whether the recovery system has been deployed.</div><div class="ttdef"><b>Definition</b> RecoverySystem.h:90</div></div>
<div class="ttc" id="aclassRecoverySystem_html_ab4db28b4ab611843003e9d6aa72b6aaf"><div class="ttname"><a href="classRecoverySystem.html#ab4db28b4ab611843003e9d6aa72b6aaf">RecoverySystem::getDragCoefficient</a></div><div class="ttdeci">double getDragCoefficient() const</div><div class="ttdoc">Gets the drag coefficient.</div><div class="ttdef"><b>Definition</b> RecoverySystem.cpp:52</div></div>
<div class="ttc" id="aclassRecoverySystem_html_abb0592632355b8102178b4814096560a"><div class="ttname"><a href="classRecoverySystem.html#abb0592632355b8102178b4814096560a">RecoverySystem::dragCoefficient_</a></div><div class="ttdeci">double dragCoefficient_</div><div class="ttdoc">Drag coefficient after deployment.</div><div class="ttdef"><b>Definition</b> RecoverySystem.h:87</div></div>
<div class="ttc" id="aclassRecoverySystem_html_aceed5eea3e65b3b1719b079f974339e9"><div class="ttname"><a href="classRecoverySystem.html#aceed5eea3e65b3b1719b079f974339e9">RecoverySystem::referenceArea_</a></div><div class="ttdeci">double referenceArea_</div><div class="ttdoc">Reference area [m2].</div><div class="ttdef"><b>Definition</b> RecoverySystem.h:88</div></div>
<div class="ttc" id="aclassRecoverySystem_html_ae51984e16fe7cf50197fd8fa95a73b7a"><div class="ttname"><a href="classRecoverySystem.html#ae51984e16fe7cf50197fd8fa95a73b7a">RecoverySystem::RecoverySystem</a></div><div class="ttdeci">RecoverySystem(const std::string &amp;name, DeploymentType deploymentType, double triggerValue, double dragCoefficient, double referenceArea)</div><div class="ttdoc">Constructs a new RecoverySystem.</div><div class="ttdef"><b>Definition</b> RecoverySystem.cpp:6</div></div>
<div class="ttc" id="aclassRecoverySystem_html_aee891188c06da83c0460b9a01cf6e2bd"><div class="ttname"><a href="classRecoverySystem.html#aee891188c06da83c0460b9a01cf6e2bd">RecoverySystem::getReferenceArea</a></div><div class="ttdeci">double getReferenceArea() const</div><div class="ttdoc">Gets the reference area.</div><div class="ttdef"><b>Definition</b> RecoverySystem.cpp:56</div></div>
<div class="ttc" id="aclassRecoverySystem_html_aef0d9ece48e151e102905459c131a443"><div class="ttname"><a href="classRecoverySystem.html#aef0d9ece48e151e102905459c131a443">RecoverySystem::isDeployed</a></div><div class="ttdeci">bool isDeployed() const</div><div class="ttdoc">Returns whether the recovery system has been deployed.</div><div class="ttdef"><b>Definition</b> RecoverySystem.cpp:48</div></div>
<div class="ttc" id="aclassRecoverySystem_html_af31cabfef9286683d4b5218b125a86bf"><div class="ttname"><a href="classRecoverySystem.html#af31cabfef9286683d4b5218b125a86bf">RecoverySystem::deploymentType_</a></div><div class="ttdeci">DeploymentType deploymentType_</div><div class="ttdoc">Deployment trigger type.</div><div class="ttdef"><b>Definition</b> RecoverySystem.h:84</div></div>
<div class="ttc" id="aclassRecoverySystem_html_af9de6ddcd7f233d24a9bacd30549c8a3"><div class="ttname"><a href="classRecoverySystem.html#af9de6ddcd7f233d24a9bacd30549c8a3">RecoverySystem::triggerValue_</a></div><div class="ttdeci">double triggerValue_</div><div class="ttdoc">Trigger value (meters for altitude, seconds for timer).</div><div class="ttdef"><b>Definition</b> RecoverySystem.h:85</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="RecoverySystem_8h.html">RecoverySystem.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>
Reference in New Issue View Git Blame Copy Permalink