qtrocket2/docs/doxygen/html/Plotter_8h_source.html

151 lines
11 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QtRocket: include/plotting/Plotter.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('Plotter_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">Plotter.h</div></div>
</div><!--header-->
<div class="contents">
<a href="Plotter_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 PLOTTER_H</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define PLOTTER_H</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;vector&gt;</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="foldopen00009" data-start="{" data-end="};">
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"><a class="line" href="classPlotter.html"> 9</a></span><span class="keyword">class </span><a class="code hl_class" href="classPlotter.html">Plotter</a> {</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="classPlotter.html#a16c3e02fb889a4fb8218b20c6b5a12ee"> 11</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classPlotter.html#a16c3e02fb889a4fb8218b20c6b5a12ee">~Plotter</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="classPlotter.html#adc6d4559aeb6bb57584bf84beb5a1b46"> 22</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classPlotter.html#adc6d4559aeb6bb57584bf84beb5a1b46">plot2D</a>(<span class="keyword">const</span> std::vector&lt;double&gt;&amp; xData,</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">const</span> std::vector&lt;double&gt;&amp; yData,</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">const</span> std::string&amp; title,</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">const</span> std::string&amp; xLabel,</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">const</span> std::string&amp; yLabel) = 0;</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="classPlotter.html#a897a38cfb07fc9c32ab5b78760e6fed0"> 35</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classPlotter.html#a897a38cfb07fc9c32ab5b78760e6fed0">addMarker</a>(<span class="keywordtype">double</span> xValue, <span class="keyword">const</span> std::string&amp; label) = 0;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="classPlotter.html#a18c94c381b1cdffd2f03e3291c9daa6b"> 45</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classPlotter.html#a18c94c381b1cdffd2f03e3291c9daa6b">plotPosVelAcc</a>(<span class="keyword">const</span> std::vector&lt;double&gt;&amp; time,</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">const</span> std::vector&lt;double&gt;&amp; altitude,</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">const</span> std::vector&lt;double&gt;&amp; velocity,</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">const</span> std::vector&lt;double&gt;&amp; acceleration) = 0;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>};</div>
</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="preprocessor">#endif </span><span class="comment">// PLOTTER_H</span></div>
<div class="ttc" id="aclassPlotter_html"><div class="ttname"><a href="classPlotter.html">Plotter</a></div><div class="ttdoc">Abstract interface for plotting flight data.</div><div class="ttdef"><b>Definition</b> Plotter.h:9</div></div>
<div class="ttc" id="aclassPlotter_html_a16c3e02fb889a4fb8218b20c6b5a12ee"><div class="ttname"><a href="classPlotter.html#a16c3e02fb889a4fb8218b20c6b5a12ee">Plotter::~Plotter</a></div><div class="ttdeci">virtual ~Plotter()=default</div></div>
<div class="ttc" id="aclassPlotter_html_a18c94c381b1cdffd2f03e3291c9daa6b"><div class="ttname"><a href="classPlotter.html#a18c94c381b1cdffd2f03e3291c9daa6b">Plotter::plotPosVelAcc</a></div><div class="ttdeci">virtual void plotPosVelAcc(const std::vector&lt; double &gt; &amp;time, const std::vector&lt; double &gt; &amp;altitude, const std::vector&lt; double &gt; &amp;velocity, const std::vector&lt; double &gt; &amp;acceleration)=0</div><div class="ttdoc">Plot altitude, velocity, and acceleration together on a single canvas.</div></div>
<div class="ttc" id="aclassPlotter_html_a897a38cfb07fc9c32ab5b78760e6fed0"><div class="ttname"><a href="classPlotter.html#a897a38cfb07fc9c32ab5b78760e6fed0">Plotter::addMarker</a></div><div class="ttdeci">virtual void addMarker(double xValue, const std::string &amp;label)=0</div><div class="ttdoc">Add a vertical marker at a specific x-axis value.</div></div>
<div class="ttc" id="aclassPlotter_html_adc6d4559aeb6bb57584bf84beb5a1b46"><div class="ttname"><a href="classPlotter.html#adc6d4559aeb6bb57584bf84beb5a1b46">Plotter::plot2D</a></div><div class="ttdeci">virtual void plot2D(const std::vector&lt; double &gt; &amp;xData, const std::vector&lt; double &gt; &amp;yData, const std::string &amp;title, const std::string &amp;xLabel, const std::string &amp;yLabel)=0</div><div class="ttdoc">Plot a 2D line graph.</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="dir_f3b3504b5687f67544bf37c71a308bf7.html">plotting</a></li><li class="navelem"><a class="el" href="Plotter_8h.html">Plotter.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>