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

648 lines
34 KiB
HTML
Raw 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: RecoverySystem Class Reference</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('classRecoverySystem.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="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classRecoverySystem-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">RecoverySystem Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Represents a recovery system for a rocket stage.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="RecoverySystem_8h_source.html">RecoverySystem.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a1efb5b07db1791eac5714825837a76d8" id="r_a1efb5b07db1791eac5714825837a76d8"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1efb5b07db1791eac5714825837a76d8">DeploymentType</a> { <a class="el" href="#a1efb5b07db1791eac5714825837a76d8a40bea05699cf5192813d9535f3e527ca">Apogee</a>
, <a class="el" href="#a1efb5b07db1791eac5714825837a76d8a613a3d4fa7b8e2538d1e559cbd572902">Altitude</a>
, <a class="el" href="#a1efb5b07db1791eac5714825837a76d8aefb4777327e6f704fb1519c1882f93ec">Timer</a>
}</td></tr>
<tr class="memdesc:a1efb5b07db1791eac5714825837a76d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deployment trigger types. <a href="#a1efb5b07db1791eac5714825837a76d8">More...</a><br /></td></tr>
<tr class="separator:a1efb5b07db1791eac5714825837a76d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae51984e16fe7cf50197fd8fa95a73b7a" id="r_ae51984e16fe7cf50197fd8fa95a73b7a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae51984e16fe7cf50197fd8fa95a73b7a">RecoverySystem</a> (const std::string &amp;name, <a class="el" href="#a1efb5b07db1791eac5714825837a76d8">DeploymentType</a> deploymentType, double triggerValue, double dragCoefficient, double referenceArea)</td></tr>
<tr class="memdesc:ae51984e16fe7cf50197fd8fa95a73b7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new <a class="el" href="classRecoverySystem.html" title="Represents a recovery system for a rocket stage.">RecoverySystem</a>. <br /></td></tr>
<tr class="separator:ae51984e16fe7cf50197fd8fa95a73b7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e6f3b43e3bc783b0187e16209732894" id="r_a7e6f3b43e3bc783b0187e16209732894"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7e6f3b43e3bc783b0187e16209732894">~RecoverySystem</a> ()=default</td></tr>
<tr class="memdesc:a7e6f3b43e3bc783b0187e16209732894"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor. <br /></td></tr>
<tr class="separator:a7e6f3b43e3bc783b0187e16209732894"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71620d51b6ed4a1c240b8267e04a6930" id="r_a71620d51b6ed4a1c240b8267e04a6930"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a71620d51b6ed4a1c240b8267e04a6930">checkDeploymentCondition</a> (double altitude, double velocity, double time, bool atApogee) const</td></tr>
<tr class="memdesc:a71620d51b6ed4a1c240b8267e04a6930"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if deployment conditions are met based on flight state. <br /></td></tr>
<tr class="separator:a71620d51b6ed4a1c240b8267e04a6930"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62619dd8617adcd5dbc373c97e9ed1ca" id="r_a62619dd8617adcd5dbc373c97e9ed1ca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a62619dd8617adcd5dbc373c97e9ed1ca">deploy</a> ()</td></tr>
<tr class="memdesc:a62619dd8617adcd5dbc373c97e9ed1ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Marks the recovery system as deployed. <br /></td></tr>
<tr class="separator:a62619dd8617adcd5dbc373c97e9ed1ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef0d9ece48e151e102905459c131a443" id="r_aef0d9ece48e151e102905459c131a443"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aef0d9ece48e151e102905459c131a443">isDeployed</a> () const</td></tr>
<tr class="memdesc:aef0d9ece48e151e102905459c131a443"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the recovery system has been deployed. <br /></td></tr>
<tr class="separator:aef0d9ece48e151e102905459c131a443"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4db28b4ab611843003e9d6aa72b6aaf" id="r_ab4db28b4ab611843003e9d6aa72b6aaf"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab4db28b4ab611843003e9d6aa72b6aaf">getDragCoefficient</a> () const</td></tr>
<tr class="memdesc:ab4db28b4ab611843003e9d6aa72b6aaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the drag coefficient. <br /></td></tr>
<tr class="separator:ab4db28b4ab611843003e9d6aa72b6aaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee891188c06da83c0460b9a01cf6e2bd" id="r_aee891188c06da83c0460b9a01cf6e2bd"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aee891188c06da83c0460b9a01cf6e2bd">getReferenceArea</a> () const</td></tr>
<tr class="memdesc:aee891188c06da83c0460b9a01cf6e2bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the reference area. <br /></td></tr>
<tr class="separator:aee891188c06da83c0460b9a01cf6e2bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bd6e22f2812d63556150eb44bbee811" id="r_a2bd6e22f2812d63556150eb44bbee811"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2bd6e22f2812d63556150eb44bbee811">getName</a> () const</td></tr>
<tr class="memdesc:a2bd6e22f2812d63556150eb44bbee811"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the name of the recovery system. <br /></td></tr>
<tr class="separator:a2bd6e22f2812d63556150eb44bbee811"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a8494f4586809c22f0537c708dba74615" id="r_a8494f4586809c22f0537c708dba74615"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8494f4586809c22f0537c708dba74615">name_</a></td></tr>
<tr class="memdesc:a8494f4586809c22f0537c708dba74615"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of the recovery system. <br /></td></tr>
<tr class="separator:a8494f4586809c22f0537c708dba74615"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af31cabfef9286683d4b5218b125a86bf" id="r_af31cabfef9286683d4b5218b125a86bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a1efb5b07db1791eac5714825837a76d8">DeploymentType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af31cabfef9286683d4b5218b125a86bf">deploymentType_</a></td></tr>
<tr class="memdesc:af31cabfef9286683d4b5218b125a86bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deployment trigger type. <br /></td></tr>
<tr class="separator:af31cabfef9286683d4b5218b125a86bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9de6ddcd7f233d24a9bacd30549c8a3" id="r_af9de6ddcd7f233d24a9bacd30549c8a3"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af9de6ddcd7f233d24a9bacd30549c8a3">triggerValue_</a></td></tr>
<tr class="memdesc:af9de6ddcd7f233d24a9bacd30549c8a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Trigger value (meters for altitude, seconds for timer). <br /></td></tr>
<tr class="separator:af9de6ddcd7f233d24a9bacd30549c8a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb0592632355b8102178b4814096560a" id="r_abb0592632355b8102178b4814096560a"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abb0592632355b8102178b4814096560a">dragCoefficient_</a></td></tr>
<tr class="memdesc:abb0592632355b8102178b4814096560a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Drag coefficient after deployment. <br /></td></tr>
<tr class="separator:abb0592632355b8102178b4814096560a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aceed5eea3e65b3b1719b079f974339e9" id="r_aceed5eea3e65b3b1719b079f974339e9"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aceed5eea3e65b3b1719b079f974339e9">referenceArea_</a></td></tr>
<tr class="memdesc:aceed5eea3e65b3b1719b079f974339e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference area [m2]. <br /></td></tr>
<tr class="separator:aceed5eea3e65b3b1719b079f974339e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa29f96ae8aa0f11f775974b8a862e02f" id="r_aa29f96ae8aa0f11f775974b8a862e02f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa29f96ae8aa0f11f775974b8a862e02f">deployed_</a></td></tr>
<tr class="memdesc:aa29f96ae8aa0f11f775974b8a862e02f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the recovery system has been deployed. <br /></td></tr>
<tr class="separator:aa29f96ae8aa0f11f775974b8a862e02f"><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>Represents a recovery system for a rocket stage. </p>
<p>The <a class="el" href="classRecoverySystem.html" title="Represents a recovery system for a rocket stage.">RecoverySystem</a> class models parachutes, drogues, or streamers and handles deployment logic based on flight conditions. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a1efb5b07db1791eac5714825837a76d8" name="a1efb5b07db1791eac5714825837a76d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1efb5b07db1791eac5714825837a76d8">&#9670;&#160;</a></span>DeploymentType</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum class <a class="el" href="#a1efb5b07db1791eac5714825837a76d8">RecoverySystem::DeploymentType</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel strong">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Deployment trigger types. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a1efb5b07db1791eac5714825837a76d8a40bea05699cf5192813d9535f3e527ca" name="a1efb5b07db1791eac5714825837a76d8a40bea05699cf5192813d9535f3e527ca"></a>Apogee&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a1efb5b07db1791eac5714825837a76d8a613a3d4fa7b8e2538d1e559cbd572902" name="a1efb5b07db1791eac5714825837a76d8a613a3d4fa7b8e2538d1e559cbd572902"></a>Altitude&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a1efb5b07db1791eac5714825837a76d8aefb4777327e6f704fb1519c1882f93ec" name="a1efb5b07db1791eac5714825837a76d8aefb4777327e6f704fb1519c1882f93ec"></a>Timer&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae51984e16fe7cf50197fd8fa95a73b7a" name="ae51984e16fe7cf50197fd8fa95a73b7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae51984e16fe7cf50197fd8fa95a73b7a">&#9670;&#160;</a></span>RecoverySystem()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RecoverySystem::RecoverySystem </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a1efb5b07db1791eac5714825837a76d8">DeploymentType</a></td> <td class="paramname"><span class="paramname"><em>deploymentType</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>triggerValue</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>dragCoefficient</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>referenceArea</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a new <a class="el" href="classRecoverySystem.html" title="Represents a recovery system for a rocket stage.">RecoverySystem</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Name of the recovery device. </td></tr>
<tr><td class="paramname">deploymentType</td><td>Type of deployment trigger (apogee, altitude, timer). </td></tr>
<tr><td class="paramname">triggerValue</td><td>Value associated with deployment trigger (e.g., altitude in meters or time in seconds). </td></tr>
<tr><td class="paramname">dragCoefficient</td><td>Drag coefficient of the recovery device. </td></tr>
<tr><td class="paramname">referenceArea</td><td>Reference area (canopy projected area) in square meters. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7e6f3b43e3bc783b0187e16209732894" name="a7e6f3b43e3bc783b0187e16209732894"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e6f3b43e3bc783b0187e16209732894">&#9670;&#160;</a></span>~RecoverySystem()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">RecoverySystem::~RecoverySystem </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel default">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a71620d51b6ed4a1c240b8267e04a6930" name="a71620d51b6ed4a1c240b8267e04a6930"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71620d51b6ed4a1c240b8267e04a6930">&#9670;&#160;</a></span>checkDeploymentCondition()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool RecoverySystem::checkDeploymentCondition </td>
<td>(</td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>altitude</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>velocity</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>time</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>atApogee</em></span>&#160;) const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if deployment conditions are met based on flight state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">altitude</td><td>Current altitude above ground (meters). </td></tr>
<tr><td class="paramname">velocity</td><td>Current vertical velocity (m/s). </td></tr>
<tr><td class="paramname">time</td><td>Elapsed flight time (seconds). </td></tr>
<tr><td class="paramname">atApogee</td><td>Flag indicating if rocket has reached apogee. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if deployment should occur. </dd></dl>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classRecoverySystem_a71620d51b6ed4a1c240b8267e04a6930_icgraph.png" border="0" usemap="#aclassRecoverySystem_a71620d51b6ed4a1c240b8267e04a6930_icgraph" alt=""/></div>
<map name="aclassRecoverySystem_a71620d51b6ed4a1c240b8267e04a6930_icgraph" id="aclassRecoverySystem_a71620d51b6ed4a1c240b8267e04a6930_icgraph">
<area shape="rect" title="Checks if deployment conditions are met based on flight state." alt="" coords="148,5,405,50"/>
<area shape="rect" href="test__recoverysystem_8cpp.html#a65aee30789a7f17227c0c71736375d03" title=" " alt="" coords="5,14,100,42"/>
<area shape="poly" title=" " alt="" coords="132,30,100,30,100,25,132,25"/>
</map>
</div>
</div>
</div>
<a id="a62619dd8617adcd5dbc373c97e9ed1ca" name="a62619dd8617adcd5dbc373c97e9ed1ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62619dd8617adcd5dbc373c97e9ed1ca">&#9670;&#160;</a></span>deploy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RecoverySystem::deploy </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Marks the recovery system as deployed. </p>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classRecoverySystem_a62619dd8617adcd5dbc373c97e9ed1ca_icgraph.png" border="0" usemap="#aclassRecoverySystem_a62619dd8617adcd5dbc373c97e9ed1ca_icgraph" alt=""/></div>
<map name="aclassRecoverySystem_a62619dd8617adcd5dbc373c97e9ed1ca_icgraph" id="aclassRecoverySystem_a62619dd8617adcd5dbc373c97e9ed1ca_icgraph">
<area shape="rect" title="Marks the recovery system as deployed." alt="" coords="148,5,331,33"/>
<area shape="rect" href="test__recoverysystem_8cpp.html#a65aee30789a7f17227c0c71736375d03" title=" " alt="" coords="5,5,100,33"/>
<area shape="poly" title=" " alt="" coords="132,22,100,22,100,16,132,16"/>
</map>
</div>
</div>
</div>
<a id="ab4db28b4ab611843003e9d6aa72b6aaf" name="ab4db28b4ab611843003e9d6aa72b6aaf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4db28b4ab611843003e9d6aa72b6aaf">&#9670;&#160;</a></span>getDragCoefficient()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double RecoverySystem::getDragCoefficient </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the drag coefficient. </p>
<dl class="section return"><dt>Returns</dt><dd>Drag coefficient (dimensionless). </dd></dl>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classRecoverySystem_ab4db28b4ab611843003e9d6aa72b6aaf_icgraph.png" border="0" usemap="#aclassRecoverySystem_ab4db28b4ab611843003e9d6aa72b6aaf_icgraph" alt=""/></div>
<map name="aclassRecoverySystem_ab4db28b4ab611843003e9d6aa72b6aaf_icgraph" id="aclassRecoverySystem_ab4db28b4ab611843003e9d6aa72b6aaf_icgraph">
<area shape="rect" title="Gets the drag coefficient." alt="" coords="148,5,410,33"/>
<area shape="rect" href="test__recoverysystem_8cpp.html#a65aee30789a7f17227c0c71736375d03" title=" " alt="" coords="5,5,100,33"/>
<area shape="poly" title=" " alt="" coords="132,22,100,22,100,16,132,16"/>
</map>
</div>
</div>
</div>
<a id="a2bd6e22f2812d63556150eb44bbee811" name="a2bd6e22f2812d63556150eb44bbee811"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2bd6e22f2812d63556150eb44bbee811">&#9670;&#160;</a></span>getName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string &amp; RecoverySystem::getName </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the name of the recovery system. </p>
<dl class="section return"><dt>Returns</dt><dd>Recovery system name as a constant reference. </dd></dl>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classRecoverySystem_a2bd6e22f2812d63556150eb44bbee811_icgraph.png" border="0" usemap="#aclassRecoverySystem_a2bd6e22f2812d63556150eb44bbee811_icgraph" alt=""/></div>
<map name="aclassRecoverySystem_a2bd6e22f2812d63556150eb44bbee811_icgraph" id="aclassRecoverySystem_a2bd6e22f2812d63556150eb44bbee811_icgraph">
<area shape="rect" title="Gets the name of the recovery system." alt="" coords="148,5,347,33"/>
<area shape="rect" href="test__recoverysystem_8cpp.html#a65aee30789a7f17227c0c71736375d03" title=" " alt="" coords="5,5,100,33"/>
<area shape="poly" title=" " alt="" coords="132,22,100,22,100,16,132,16"/>
</map>
</div>
</div>
</div>
<a id="aee891188c06da83c0460b9a01cf6e2bd" name="aee891188c06da83c0460b9a01cf6e2bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee891188c06da83c0460b9a01cf6e2bd">&#9670;&#160;</a></span>getReferenceArea()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double RecoverySystem::getReferenceArea </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the reference area. </p>
<dl class="section return"><dt>Returns</dt><dd>Reference area (square meters). </dd></dl>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classRecoverySystem_aee891188c06da83c0460b9a01cf6e2bd_icgraph.png" border="0" usemap="#aclassRecoverySystem_aee891188c06da83c0460b9a01cf6e2bd_icgraph" alt=""/></div>
<map name="aclassRecoverySystem_aee891188c06da83c0460b9a01cf6e2bd_icgraph" id="aclassRecoverySystem_aee891188c06da83c0460b9a01cf6e2bd_icgraph">
<area shape="rect" title="Gets the reference area." alt="" coords="148,5,404,33"/>
<area shape="rect" href="test__recoverysystem_8cpp.html#a65aee30789a7f17227c0c71736375d03" title=" " alt="" coords="5,5,100,33"/>
<area shape="poly" title=" " alt="" coords="132,22,100,22,100,16,132,16"/>
</map>
</div>
</div>
</div>
<a id="aef0d9ece48e151e102905459c131a443" name="aef0d9ece48e151e102905459c131a443"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef0d9ece48e151e102905459c131a443">&#9670;&#160;</a></span>isDeployed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool RecoverySystem::isDeployed </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns whether the recovery system has been deployed. </p>
<dl class="section return"><dt>Returns</dt><dd>True if deployed. </dd></dl>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classRecoverySystem_aef0d9ece48e151e102905459c131a443_icgraph.png" border="0" usemap="#aclassRecoverySystem_aef0d9ece48e151e102905459c131a443_icgraph" alt=""/></div>
<map name="aclassRecoverySystem_aef0d9ece48e151e102905459c131a443_icgraph" id="aclassRecoverySystem_aef0d9ece48e151e102905459c131a443_icgraph">
<area shape="rect" title="Returns whether the recovery system has been deployed." alt="" coords="148,5,360,33"/>
<area shape="rect" href="test__recoverysystem_8cpp.html#a65aee30789a7f17227c0c71736375d03" title=" " alt="" coords="5,5,100,33"/>
<area shape="poly" title=" " alt="" coords="132,22,100,22,100,16,132,16"/>
</map>
</div>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aa29f96ae8aa0f11f775974b8a862e02f" name="aa29f96ae8aa0f11f775974b8a862e02f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa29f96ae8aa0f11f775974b8a862e02f">&#9670;&#160;</a></span>deployed_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool RecoverySystem::deployed_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Whether the recovery system has been deployed. </p>
</div>
</div>
<a id="af31cabfef9286683d4b5218b125a86bf" name="af31cabfef9286683d4b5218b125a86bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af31cabfef9286683d4b5218b125a86bf">&#9670;&#160;</a></span>deploymentType_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#a1efb5b07db1791eac5714825837a76d8">DeploymentType</a> RecoverySystem::deploymentType_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Deployment trigger type. </p>
</div>
</div>
<a id="abb0592632355b8102178b4814096560a" name="abb0592632355b8102178b4814096560a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb0592632355b8102178b4814096560a">&#9670;&#160;</a></span>dragCoefficient_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double RecoverySystem::dragCoefficient_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Drag coefficient after deployment. </p>
</div>
</div>
<a id="a8494f4586809c22f0537c708dba74615" name="a8494f4586809c22f0537c708dba74615"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8494f4586809c22f0537c708dba74615">&#9670;&#160;</a></span>name_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string RecoverySystem::name_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Name of the recovery system. </p>
</div>
</div>
<a id="aceed5eea3e65b3b1719b079f974339e9" name="aceed5eea3e65b3b1719b079f974339e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aceed5eea3e65b3b1719b079f974339e9">&#9670;&#160;</a></span>referenceArea_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double RecoverySystem::referenceArea_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reference area [m2]. </p>
</div>
</div>
<a id="af9de6ddcd7f233d24a9bacd30549c8a3" name="af9de6ddcd7f233d24a9bacd30549c8a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9de6ddcd7f233d24a9bacd30549c8a3">&#9670;&#160;</a></span>triggerValue_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double RecoverySystem::triggerValue_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Trigger value (meters for altitude, seconds for timer). </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/<a class="el" href="RecoverySystem_8h_source.html">RecoverySystem.h</a></li>
<li>src/<a class="el" href="RecoverySystem_8cpp.html">RecoverySystem.cpp</a></li>
</ul>
</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="classRecoverySystem.html">RecoverySystem</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