qtrocket2/docs/doxygen/html/classMotor.html

756 lines
38 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: Motor 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('classMotor.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-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classMotor-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Motor Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Represents a rocket motor with thrust characteristics over time.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Motor_8h_source.html">Motor.h</a>&gt;</code></p>
<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:af5e02cef2ac226d6010f8fff41691525" id="r_af5e02cef2ac226d6010f8fff41691525"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af5e02cef2ac226d6010f8fff41691525">Motor</a> (const std::string &amp;name, double initialPropellantMass, double totalImpulse)</td></tr>
<tr class="memdesc:af5e02cef2ac226d6010f8fff41691525"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new <a class="el" href="classMotor.html" title="Represents a rocket motor with thrust characteristics over time.">Motor</a> with a given name and mass properties. <br /></td></tr>
<tr class="separator:af5e02cef2ac226d6010f8fff41691525"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a063b9cf447524451c905cc9f1ea67261" id="r_a063b9cf447524451c905cc9f1ea67261"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a063b9cf447524451c905cc9f1ea67261">~Motor</a> ()=default</td></tr>
<tr class="memdesc:a063b9cf447524451c905cc9f1ea67261"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor. <br /></td></tr>
<tr class="separator:a063b9cf447524451c905cc9f1ea67261"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aacfe43afae59ccf8de9333b97f20b496" id="r_aacfe43afae59ccf8de9333b97f20b496"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aacfe43afae59ccf8de9333b97f20b496">addThrustDataPoint</a> (double time, double thrust)</td></tr>
<tr class="memdesc:aacfe43afae59ccf8de9333b97f20b496"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a thrust curve data point. <br /></td></tr>
<tr class="separator:aacfe43afae59ccf8de9333b97f20b496"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84c88f99c6dcd106ff621d9bc86d86d2" id="r_a84c88f99c6dcd106ff621d9bc86d86d2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a84c88f99c6dcd106ff621d9bc86d86d2">ignite</a> ()</td></tr>
<tr class="memdesc:a84c88f99c6dcd106ff621d9bc86d86d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts motor ignition (sets internal ignition time to zero). <br /></td></tr>
<tr class="separator:a84c88f99c6dcd106ff621d9bc86d86d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff6dc2a5d1b86043c3670d5d126fabe0" id="r_aff6dc2a5d1b86043c3670d5d126fabe0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aff6dc2a5d1b86043c3670d5d126fabe0">update</a> (double deltaTime)</td></tr>
<tr class="memdesc:aff6dc2a5d1b86043c3670d5d126fabe0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the motor status based on elapsed time. <br /></td></tr>
<tr class="separator:aff6dc2a5d1b86043c3670d5d126fabe0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2dc32cd5990b69f58b4a2441615a2482" id="r_a2dc32cd5990b69f58b4a2441615a2482"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2dc32cd5990b69f58b4a2441615a2482">getCurrentThrust</a> () const</td></tr>
<tr class="memdesc:a2dc32cd5990b69f58b4a2441615a2482"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current thrust output. <br /></td></tr>
<tr class="separator:a2dc32cd5990b69f58b4a2441615a2482"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48d0d93602b089fce9bc24a469ef1a3a" id="r_a48d0d93602b089fce9bc24a469ef1a3a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a48d0d93602b089fce9bc24a469ef1a3a">isBurnedOut</a> () const</td></tr>
<tr class="memdesc:a48d0d93602b089fce9bc24a469ef1a3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether the motor has burned out. <br /></td></tr>
<tr class="separator:a48d0d93602b089fce9bc24a469ef1a3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aefeec4b2190b66d7f0131f91746c05d1" id="r_aefeec4b2190b66d7f0131f91746c05d1"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aefeec4b2190b66d7f0131f91746c05d1">getRemainingPropellantMass</a> () const</td></tr>
<tr class="memdesc:aefeec4b2190b66d7f0131f91746c05d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the remaining propellant mass. <br /></td></tr>
<tr class="separator:aefeec4b2190b66d7f0131f91746c05d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bbe913797a4890d917fdfbd055fd7be" id="r_a5bbe913797a4890d917fdfbd055fd7be"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5bbe913797a4890d917fdfbd055fd7be">getName</a> () const</td></tr>
<tr class="memdesc:a5bbe913797a4890d917fdfbd055fd7be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the name of the motor. <br /></td></tr>
<tr class="separator:a5bbe913797a4890d917fdfbd055fd7be"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:ab8cd621406d2641b8e0f2961323c65b8" id="r_ab8cd621406d2641b8e0f2961323c65b8"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab8cd621406d2641b8e0f2961323c65b8">interpolateThrust</a> (double time) const</td></tr>
<tr class="memdesc:ab8cd621406d2641b8e0f2961323c65b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Linearly interpolates thrust from the thrust curve. <br /></td></tr>
<tr class="separator:ab8cd621406d2641b8e0f2961323c65b8"><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:af28ab39a0f1fae7bab69f6a0b6721dbc" id="r_af28ab39a0f1fae7bab69f6a0b6721dbc"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af28ab39a0f1fae7bab69f6a0b6721dbc">name_</a></td></tr>
<tr class="memdesc:af28ab39a0f1fae7bab69f6a0b6721dbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of the motor. <br /></td></tr>
<tr class="separator:af28ab39a0f1fae7bab69f6a0b6721dbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4203ea6011fe07e34a49597803874bc" id="r_af4203ea6011fe07e34a49597803874bc"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af4203ea6011fe07e34a49597803874bc">initialPropellantMass_</a></td></tr>
<tr class="memdesc:af4203ea6011fe07e34a49597803874bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initial propellant mass [kg]. <br /></td></tr>
<tr class="separator:af4203ea6011fe07e34a49597803874bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a962d098d64f48d6025a49ad5c7b8c265" id="r_a962d098d64f48d6025a49ad5c7b8c265"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a962d098d64f48d6025a49ad5c7b8c265">remainingPropellantMass_</a></td></tr>
<tr class="memdesc:a962d098d64f48d6025a49ad5c7b8c265"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current propellant mass [kg]. <br /></td></tr>
<tr class="separator:a962d098d64f48d6025a49ad5c7b8c265"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff81edcd784fc32bcdf2b663ca1b245c" id="r_aff81edcd784fc32bcdf2b663ca1b245c"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aff81edcd784fc32bcdf2b663ca1b245c">totalImpulse_</a></td></tr>
<tr class="memdesc:aff81edcd784fc32bcdf2b663ca1b245c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total impulse [Ns], used for sanity checks. <br /></td></tr>
<tr class="separator:aff81edcd784fc32bcdf2b663ca1b245c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb6c324afea4c2e17064fdb7709dfe67" id="r_adb6c324afea4c2e17064fdb7709dfe67"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::pair&lt; double, double &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adb6c324afea4c2e17064fdb7709dfe67">thrustCurve_</a></td></tr>
<tr class="memdesc:adb6c324afea4c2e17064fdb7709dfe67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Thrust curve (time, thrust) points. <br /></td></tr>
<tr class="separator:adb6c324afea4c2e17064fdb7709dfe67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12ac86c4706de3886f7a579f7d54555a" id="r_a12ac86c4706de3886f7a579f7d54555a"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a12ac86c4706de3886f7a579f7d54555a">ignitionTime_</a></td></tr>
<tr class="memdesc:a12ac86c4706de3886f7a579f7d54555a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Elapsed time since ignition [s]. <br /></td></tr>
<tr class="separator:a12ac86c4706de3886f7a579f7d54555a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36b00ad7f46dfb1ee0ad5d1d6d173801" id="r_a36b00ad7f46dfb1ee0ad5d1d6d173801"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a36b00ad7f46dfb1ee0ad5d1d6d173801">ignited_</a></td></tr>
<tr class="memdesc:a36b00ad7f46dfb1ee0ad5d1d6d173801"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the motor has been ignited. <br /></td></tr>
<tr class="separator:a36b00ad7f46dfb1ee0ad5d1d6d173801"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e3d871b3ba8213170d3649fb2418466" id="r_a2e3d871b3ba8213170d3649fb2418466"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2e3d871b3ba8213170d3649fb2418466">burnedOut_</a></td></tr>
<tr class="memdesc:a2e3d871b3ba8213170d3649fb2418466"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the motor has finished burning. <br /></td></tr>
<tr class="separator:a2e3d871b3ba8213170d3649fb2418466"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa92df0cbc929f46a0b45ef733be45db5" id="r_aa92df0cbc929f46a0b45ef733be45db5"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa92df0cbc929f46a0b45ef733be45db5">currentThrust_</a></td></tr>
<tr class="memdesc:aa92df0cbc929f46a0b45ef733be45db5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cached current thrust [N]. <br /></td></tr>
<tr class="separator:aa92df0cbc929f46a0b45ef733be45db5"><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 rocket motor with thrust characteristics over time. </p>
<p>The <a class="el" href="classMotor.html" title="Represents a rocket motor with thrust characteristics over time.">Motor</a> class manages the thrust curve, ignition timing, burn duration, and remaining propellant mass of a single propulsion unit. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af5e02cef2ac226d6010f8fff41691525" name="af5e02cef2ac226d6010f8fff41691525"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5e02cef2ac226d6010f8fff41691525">&#9670;&#160;</a></span>Motor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Motor::Motor </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">double</td> <td class="paramname"><span class="paramname"><em>initialPropellantMass</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>totalImpulse</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a new <a class="el" href="classMotor.html" title="Represents a rocket motor with thrust characteristics over time.">Motor</a> with a given name and mass properties. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Name of the motor. </td></tr>
<tr><td class="paramname">initialPropellantMass</td><td>Initial mass of propellant (kg). </td></tr>
<tr><td class="paramname">totalImpulse</td><td>Total impulse (Ns) for basic verification. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a063b9cf447524451c905cc9f1ea67261" name="a063b9cf447524451c905cc9f1ea67261"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a063b9cf447524451c905cc9f1ea67261">&#9670;&#160;</a></span>~Motor()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Motor::~Motor </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="aacfe43afae59ccf8de9333b97f20b496" name="aacfe43afae59ccf8de9333b97f20b496"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacfe43afae59ccf8de9333b97f20b496">&#9670;&#160;</a></span>addThrustDataPoint()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Motor::addThrustDataPoint </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">double</td> <td class="paramname"><span class="paramname"><em>thrust</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a thrust curve data point. </p>
<p>Should be called during setup. Time must be monotonically increasing.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">time</td><td>Time since ignition (seconds). </td></tr>
<tr><td class="paramname">thrust</td><td>Thrust at this time (Newtons). </td></tr>
</table>
</dd>
</dl>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classMotor_aacfe43afae59ccf8de9333b97f20b496_icgraph.png" border="0" usemap="#aclassMotor_aacfe43afae59ccf8de9333b97f20b496_icgraph" alt=""/></div>
<map name="aclassMotor_aacfe43afae59ccf8de9333b97f20b496_icgraph" id="aclassMotor_aacfe43afae59ccf8de9333b97f20b496_icgraph">
<area shape="rect" title="Adds a thrust curve data point." alt="" coords="148,5,344,33"/>
<area shape="rect" href="test__motor_8cpp.html#a3989a24eb2c673403eddb875a991d319" 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="a2dc32cd5990b69f58b4a2441615a2482" name="a2dc32cd5990b69f58b4a2441615a2482"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2dc32cd5990b69f58b4a2441615a2482">&#9670;&#160;</a></span>getCurrentThrust()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double Motor::getCurrentThrust </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 current thrust output. </p>
<dl class="section return"><dt>Returns</dt><dd>Current thrust in Newtons. </dd></dl>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classMotor_a2dc32cd5990b69f58b4a2441615a2482_icgraph.png" border="0" usemap="#aclassMotor_a2dc32cd5990b69f58b4a2441615a2482_icgraph" alt=""/></div>
<map name="aclassMotor_a2dc32cd5990b69f58b4a2441615a2482_icgraph" id="aclassMotor_a2dc32cd5990b69f58b4a2441615a2482_icgraph">
<area shape="rect" title="Gets the current thrust output." alt="" coords="148,5,325,33"/>
<area shape="rect" href="test__motor_8cpp.html#a3989a24eb2c673403eddb875a991d319" 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="a5bbe913797a4890d917fdfbd055fd7be" name="a5bbe913797a4890d917fdfbd055fd7be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bbe913797a4890d917fdfbd055fd7be">&#9670;&#160;</a></span>getName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string &amp; Motor::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 motor. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classMotor.html" title="Represents a rocket motor with thrust characteristics over time.">Motor</a> name as a constant reference. </dd></dl>
</div>
</div>
<a id="aefeec4b2190b66d7f0131f91746c05d1" name="aefeec4b2190b66d7f0131f91746c05d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aefeec4b2190b66d7f0131f91746c05d1">&#9670;&#160;</a></span>getRemainingPropellantMass()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double Motor::getRemainingPropellantMass </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 the remaining propellant mass. </p>
<dl class="section return"><dt>Returns</dt><dd>Remaining propellant mass in kilograms. </dd></dl>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classMotor_aefeec4b2190b66d7f0131f91746c05d1_icgraph.png" border="0" usemap="#aclassMotor_aefeec4b2190b66d7f0131f91746c05d1_icgraph" alt=""/></div>
<map name="aclassMotor_aefeec4b2190b66d7f0131f91746c05d1_icgraph" id="aclassMotor_aefeec4b2190b66d7f0131f91746c05d1_icgraph">
<area shape="rect" title="Returns the remaining propellant mass." alt="" coords="148,5,406,33"/>
<area shape="rect" href="test__motor_8cpp.html#a3989a24eb2c673403eddb875a991d319" 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="a84c88f99c6dcd106ff621d9bc86d86d2" name="a84c88f99c6dcd106ff621d9bc86d86d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84c88f99c6dcd106ff621d9bc86d86d2">&#9670;&#160;</a></span>ignite()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Motor::ignite </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts motor ignition (sets internal ignition time to zero). </p>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classMotor_a84c88f99c6dcd106ff621d9bc86d86d2_icgraph.png" border="0" usemap="#aclassMotor_a84c88f99c6dcd106ff621d9bc86d86d2_icgraph" alt=""/></div>
<map name="aclassMotor_a84c88f99c6dcd106ff621d9bc86d86d2_icgraph" id="aclassMotor_a84c88f99c6dcd106ff621d9bc86d86d2_icgraph">
<area shape="rect" title="Starts motor ignition (sets internal ignition time to zero)." alt="" coords="148,5,252,33"/>
<area shape="rect" href="test__motor_8cpp.html#a3989a24eb2c673403eddb875a991d319" 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="ab8cd621406d2641b8e0f2961323c65b8" name="ab8cd621406d2641b8e0f2961323c65b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8cd621406d2641b8e0f2961323c65b8">&#9670;&#160;</a></span>interpolateThrust()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double Motor::interpolateThrust </td>
<td>(</td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>time</em></span></td><td>)</td>
<td> const</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>Linearly interpolates thrust from the thrust curve. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">time</td><td>Time since ignition (seconds). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Interpolated thrust (Newtons). </dd></dl>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classMotor_ab8cd621406d2641b8e0f2961323c65b8_icgraph.png" border="0" usemap="#aclassMotor_ab8cd621406d2641b8e0f2961323c65b8_icgraph" alt=""/></div>
<map name="aclassMotor_ab8cd621406d2641b8e0f2961323c65b8_icgraph" id="aclassMotor_ab8cd621406d2641b8e0f2961323c65b8_icgraph">
<area shape="rect" title="Linearly interpolates thrust from the thrust curve." alt="" coords="308,5,487,33"/>
<area shape="rect" href="classMotor.html#aff6dc2a5d1b86043c3670d5d126fabe0" title="Updates the motor status based on elapsed time." alt="" coords="148,5,260,33"/>
<area shape="poly" title=" " alt="" coords="292,22,261,22,261,16,292,16"/>
<area shape="rect" href="test__motor_8cpp.html#a3989a24eb2c673403eddb875a991d319" 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="a48d0d93602b089fce9bc24a469ef1a3a" name="a48d0d93602b089fce9bc24a469ef1a3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48d0d93602b089fce9bc24a469ef1a3a">&#9670;&#160;</a></span>isBurnedOut()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Motor::isBurnedOut </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>Checks whether the motor has burned out. </p>
<dl class="section return"><dt>Returns</dt><dd>True if burnout has occurred. </dd></dl>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classMotor_a48d0d93602b089fce9bc24a469ef1a3a_icgraph.png" border="0" usemap="#aclassMotor_a48d0d93602b089fce9bc24a469ef1a3a_icgraph" alt=""/></div>
<map name="aclassMotor_a48d0d93602b089fce9bc24a469ef1a3a_icgraph" id="aclassMotor_a48d0d93602b089fce9bc24a469ef1a3a_icgraph">
<area shape="rect" title="Checks whether the motor has burned out." alt="" coords="148,5,295,33"/>
<area shape="rect" href="test__motor_8cpp.html#a3989a24eb2c673403eddb875a991d319" 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="aff6dc2a5d1b86043c3670d5d126fabe0" name="aff6dc2a5d1b86043c3670d5d126fabe0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff6dc2a5d1b86043c3670d5d126fabe0">&#9670;&#160;</a></span>update()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Motor::update </td>
<td>(</td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>deltaTime</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Updates the motor status based on elapsed time. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deltaTime</td><td>Time step in seconds. </td></tr>
</table>
</dd>
</dl>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classMotor_aff6dc2a5d1b86043c3670d5d126fabe0_cgraph.png" border="0" usemap="#aclassMotor_aff6dc2a5d1b86043c3670d5d126fabe0_cgraph" alt=""/></div>
<map name="aclassMotor_aff6dc2a5d1b86043c3670d5d126fabe0_cgraph" id="aclassMotor_aff6dc2a5d1b86043c3670d5d126fabe0_cgraph">
<area shape="rect" title="Updates the motor status based on elapsed time." alt="" coords="5,5,118,33"/>
<area shape="rect" href="classMotor.html#ab8cd621406d2641b8e0f2961323c65b8" title="Linearly interpolates thrust from the thrust curve." alt="" coords="166,5,345,33"/>
<area shape="poly" title=" " alt="" coords="118,16,150,16,150,22,118,22"/>
</map>
</div>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classMotor_aff6dc2a5d1b86043c3670d5d126fabe0_icgraph.png" border="0" usemap="#aclassMotor_aff6dc2a5d1b86043c3670d5d126fabe0_icgraph" alt=""/></div>
<map name="aclassMotor_aff6dc2a5d1b86043c3670d5d126fabe0_icgraph" id="aclassMotor_aff6dc2a5d1b86043c3670d5d126fabe0_icgraph">
<area shape="rect" title="Updates the motor status based on elapsed time." alt="" coords="148,5,260,33"/>
<area shape="rect" href="test__motor_8cpp.html#a3989a24eb2c673403eddb875a991d319" 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="a2e3d871b3ba8213170d3649fb2418466" name="a2e3d871b3ba8213170d3649fb2418466"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e3d871b3ba8213170d3649fb2418466">&#9670;&#160;</a></span>burnedOut_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Motor::burnedOut_</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 motor has finished burning. </p>
</div>
</div>
<a id="aa92df0cbc929f46a0b45ef733be45db5" name="aa92df0cbc929f46a0b45ef733be45db5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa92df0cbc929f46a0b45ef733be45db5">&#9670;&#160;</a></span>currentThrust_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double Motor::currentThrust_</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>Cached current thrust [N]. </p>
</div>
</div>
<a id="a36b00ad7f46dfb1ee0ad5d1d6d173801" name="a36b00ad7f46dfb1ee0ad5d1d6d173801"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36b00ad7f46dfb1ee0ad5d1d6d173801">&#9670;&#160;</a></span>ignited_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Motor::ignited_</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 motor has been ignited. </p>
</div>
</div>
<a id="a12ac86c4706de3886f7a579f7d54555a" name="a12ac86c4706de3886f7a579f7d54555a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12ac86c4706de3886f7a579f7d54555a">&#9670;&#160;</a></span>ignitionTime_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double Motor::ignitionTime_</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>Elapsed time since ignition [s]. </p>
</div>
</div>
<a id="af4203ea6011fe07e34a49597803874bc" name="af4203ea6011fe07e34a49597803874bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4203ea6011fe07e34a49597803874bc">&#9670;&#160;</a></span>initialPropellantMass_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double Motor::initialPropellantMass_</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>Initial propellant mass [kg]. </p>
</div>
</div>
<a id="af28ab39a0f1fae7bab69f6a0b6721dbc" name="af28ab39a0f1fae7bab69f6a0b6721dbc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af28ab39a0f1fae7bab69f6a0b6721dbc">&#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 Motor::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 motor. </p>
</div>
</div>
<a id="a962d098d64f48d6025a49ad5c7b8c265" name="a962d098d64f48d6025a49ad5c7b8c265"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a962d098d64f48d6025a49ad5c7b8c265">&#9670;&#160;</a></span>remainingPropellantMass_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double Motor::remainingPropellantMass_</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>Current propellant mass [kg]. </p>
</div>
</div>
<a id="adb6c324afea4c2e17064fdb7709dfe67" name="adb6c324afea4c2e17064fdb7709dfe67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb6c324afea4c2e17064fdb7709dfe67">&#9670;&#160;</a></span>thrustCurve_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;std::pair&lt;double, double&gt; &gt; Motor::thrustCurve_</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>Thrust curve (time, thrust) points. </p>
</div>
</div>
<a id="aff81edcd784fc32bcdf2b663ca1b245c" name="aff81edcd784fc32bcdf2b663ca1b245c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff81edcd784fc32bcdf2b663ca1b245c">&#9670;&#160;</a></span>totalImpulse_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double Motor::totalImpulse_</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>Total impulse [Ns], used for sanity checks. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/<a class="el" href="Motor_8h_source.html">Motor.h</a></li>
<li>src/<a class="el" href="Motor_8cpp.html">Motor.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="classMotor.html">Motor</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>