source: flair-dev/trunk/doc/Flair/classflair_1_1gui_1_1_data_plot2_d.html @ 98

Last change on this file since 98 was 98, checked in by Sanahuja Guillaume, 21 months ago

cleanup for out of source build

File size: 17.2 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.9.1"/>
7<title>Flair: flair::gui::DataPlot2D Class Reference</title>
8<link href="tabs.css" rel="stylesheet" type="text/css"/>
9<script type="text/javascript" src="jquery.js"></script>
10<script type="text/javascript" src="dynsections.js"></script>
11<link href="navtree.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="resize.js"></script>
13<script type="text/javascript" src="navtreedata.js"></script>
14<script type="text/javascript" src="navtree.js"></script>
15<script type="text/javascript">
16  $(document).ready(initResizable);
17  $(window).load(resizeHeight);
18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
20<script type="text/javascript" src="search/searchdata.js"></script>
21<script type="text/javascript" src="search/search.js"></script>
22<script type="text/javascript">
23  $(document).ready(function() { init_search(); });
24</script>
25<link href="doxygen.css" rel="stylesheet" type="text/css" />
26</head>
27<body>
28<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
29<div id="titlearea">
30<table cellspacing="0" cellpadding="0">
31 <tbody>
32 <tr style="height: 56px;">
33  <td id="projectlogo"><img alt="Logo" src="logo_hds.png"/></td>
34  <td style="padding-left: 0.5em;">
35   <div id="projectname">Flair
36   </div>
37   <div id="projectbrief">Framework Libre Air</div>
38  </td>
39 </tr>
40 </tbody>
41</table>
42</div>
43<!-- end header part -->
44<!-- Generated by Doxygen 1.8.9.1 -->
45<script type="text/javascript">
46var searchBox = new SearchBox("searchBox", "search",false,'Search');
47</script>
48  <div id="navrow1" class="tabs">
49    <ul class="tablist">
50      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
51      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
52      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
53      <li><a href="files.html"><span>Files</span></a></li>
54      <li>
55        <div id="MSearchBox" class="MSearchBoxInactive">
56        <span class="left">
57          <img id="MSearchSelect" src="search/mag_sel.png"
58               onmouseover="return searchBox.OnSearchSelectShow()"
59               onmouseout="return searchBox.OnSearchSelectHide()"
60               alt=""/>
61          <input type="text" id="MSearchField" value="Search" accesskey="S"
62               onfocus="searchBox.OnSearchFieldFocus(true)" 
63               onblur="searchBox.OnSearchFieldFocus(false)" 
64               onkeyup="searchBox.OnSearchFieldChange(event)"/>
65          </span><span class="right">
66            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
67          </span>
68        </div>
69      </li>
70    </ul>
71  </div>
72  <div id="navrow2" class="tabs2">
73    <ul class="tablist">
74      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
75      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
76      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
77      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
78    </ul>
79  </div>
80</div><!-- top -->
81<div id="side-nav" class="ui-resizable side-nav-resizable">
82  <div id="nav-tree">
83    <div id="nav-tree-contents">
84      <div id="nav-sync" class="sync"></div>
85    </div>
86  </div>
87  <div id="splitbar" style="-moz-user-select:none;" 
88       class="ui-resizable-handle">
89  </div>
90</div>
91<script type="text/javascript">
92$(document).ready(function(){initNavTree('classflair_1_1gui_1_1_data_plot2_d.html','');});
93</script>
94<div id="doc-content">
95<!-- window showing the filter options -->
96<div id="MSearchSelectWindow"
97     onmouseover="return searchBox.OnSearchSelectShow()"
98     onmouseout="return searchBox.OnSearchSelectHide()"
99     onkeydown="return searchBox.OnSearchSelectKey(event)">
100</div>
101
102<!-- iframe showing the search results (closed by default) -->
103<div id="MSearchResultsWindow">
104<iframe src="javascript:void(0)" frameborder="0" 
105        name="MSearchResults" id="MSearchResults">
106</iframe>
107</div>
108
109<div class="header">
110  <div class="summary">
111<a href="#pub-methods">Public Member Functions</a> &#124;
112<a href="classflair_1_1gui_1_1_data_plot2_d-members.html">List of all members</a>  </div>
113  <div class="headertitle">
114<div class="title">flair::gui::DataPlot2D Class Reference</div>  </div>
115</div><!--header-->
116<div class="contents">
117
118<p>Class displaying a 2D plot on the ground station. 
119 <a href="classflair_1_1gui_1_1_data_plot2_d.html#details">More...</a></p>
120
121<p><code>#include &lt;<a class="el" href="_data_plot2_d_8h_source.html">DataPlot2D.h</a>&gt;</code></p>
122<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
123  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for flair::gui::DataPlot2D:</div>
124<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
125</div>
126<div id="dynsection-0-content" class="dyncontent" style="display:none;">
127 <div class="center">
128  <img src="classflair_1_1gui_1_1_data_plot2_d.png" usemap="#flair::gui::DataPlot2D_map" alt=""/>
129  <map id="flair::gui::DataPlot2D_map" name="flair::gui::DataPlot2D_map">
130<area href="classflair_1_1gui_1_1_data_plot.html" title="Abstract class to display plots on ground station. " alt="flair::gui::DataPlot" shape="rect" coords="0,0,126,24"/>
131</map>
132 </div></div>
133<table class="memberdecls">
134<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
135Public Member Functions</h2></td></tr>
136<tr class="memitem:a14cfb30a1f56d6f7acc5f225a24d213f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_data_plot2_d.html#a14cfb30a1f56d6f7acc5f225a24d213f">DataPlot2D</a> (const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">LayoutPosition</a> *position, std::string name, std::string x_name, float xmin, float xmax, std::string y_name, float ymin, float ymax)</td></tr>
137<tr class="memdesc:a14cfb30a1f56d6f7acc5f225a24d213f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a14cfb30a1f56d6f7acc5f225a24d213f">More...</a><br /></td></tr>
138<tr class="separator:a14cfb30a1f56d6f7acc5f225a24d213f"><td class="memSeparator" colspan="2">&#160;</td></tr>
139<tr class="memitem:a1bae1723d99ae31d9c1936f782d9ee3e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_data_plot2_d.html#a1bae1723d99ae31d9c1936f782d9ee3e">~DataPlot2D</a> ()</td></tr>
140<tr class="memdesc:a1bae1723d99ae31d9c1936f782d9ee3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a1bae1723d99ae31d9c1936f782d9ee3e">More...</a><br /></td></tr>
141<tr class="separator:a1bae1723d99ae31d9c1936f782d9ee3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
142<tr class="memitem:add21a8cf4753bd3329534739cea5073e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_data_plot2_d.html#add21a8cf4753bd3329534739cea5073e">AddCurve</a> (const <a class="el" href="classflair_1_1core_1_1_i_o_data_element.html">core::IODataElement</a> *x_element, const <a class="el" href="classflair_1_1core_1_1_i_o_data_element.html">core::IODataElement</a> *y_element, <a class="el" href="classflair_1_1gui_1_1_data_plot.html#a0e106271554ff92ebeb94d22014f037e">Color_t</a> color, std::string curve_name=&quot;&quot;)</td></tr>
143<tr class="memdesc:add21a8cf4753bd3329534739cea5073e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a curve from elements to the plot.  <a href="#add21a8cf4753bd3329534739cea5073e">More...</a><br /></td></tr>
144<tr class="separator:add21a8cf4753bd3329534739cea5073e"><td class="memSeparator" colspan="2">&#160;</td></tr>
145<tr class="memitem:a86a4caf997b35f97b97021090bc7be64"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_data_plot2_d.html#a86a4caf997b35f97b97021090bc7be64">AddCurve</a> (const <a class="el" href="classflair_1_1core_1_1_i_o_data_element.html">core::IODataElement</a> *x_element, const <a class="el" href="classflair_1_1core_1_1_i_o_data_element.html">core::IODataElement</a> *y_element, uint8_t r=255, uint8_t g=0, uint8_t b=0, std::string curve_name=&quot;&quot;)</td></tr>
146<tr class="memdesc:a86a4caf997b35f97b97021090bc7be64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a curve from elements to the plot.  <a href="#a86a4caf997b35f97b97021090bc7be64">More...</a><br /></td></tr>
147<tr class="separator:a86a4caf997b35f97b97021090bc7be64"><td class="memSeparator" colspan="2">&#160;</td></tr>
148</table>
149<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
150<div class="textblock"><p>Class displaying a 2D plot on the ground station. </p>
151</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
152<a class="anchor" id="a14cfb30a1f56d6f7acc5f225a24d213f"></a>
153<div class="memitem">
154<div class="memproto">
155      <table class="memname">
156        <tr>
157          <td class="memname">flair::gui::DataPlot2D::DataPlot2D </td>
158          <td>(</td>
159          <td class="paramtype">const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">LayoutPosition</a> *&#160;</td>
160          <td class="paramname"><em>position</em>, </td>
161        </tr>
162        <tr>
163          <td class="paramkey"></td>
164          <td></td>
165          <td class="paramtype">std::string&#160;</td>
166          <td class="paramname"><em>name</em>, </td>
167        </tr>
168        <tr>
169          <td class="paramkey"></td>
170          <td></td>
171          <td class="paramtype">std::string&#160;</td>
172          <td class="paramname"><em>x_name</em>, </td>
173        </tr>
174        <tr>
175          <td class="paramkey"></td>
176          <td></td>
177          <td class="paramtype">float&#160;</td>
178          <td class="paramname"><em>xmin</em>, </td>
179        </tr>
180        <tr>
181          <td class="paramkey"></td>
182          <td></td>
183          <td class="paramtype">float&#160;</td>
184          <td class="paramname"><em>xmax</em>, </td>
185        </tr>
186        <tr>
187          <td class="paramkey"></td>
188          <td></td>
189          <td class="paramtype">std::string&#160;</td>
190          <td class="paramname"><em>y_name</em>, </td>
191        </tr>
192        <tr>
193          <td class="paramkey"></td>
194          <td></td>
195          <td class="paramtype">float&#160;</td>
196          <td class="paramname"><em>ymin</em>, </td>
197        </tr>
198        <tr>
199          <td class="paramkey"></td>
200          <td></td>
201          <td class="paramtype">float&#160;</td>
202          <td class="paramname"><em>ymax</em>&#160;</td>
203        </tr>
204        <tr>
205          <td></td>
206          <td>)</td>
207          <td></td><td></td>
208        </tr>
209      </table>
210</div><div class="memdoc">
211
212<p>Constructor. </p>
213<p>Construct a 2D plot at given place position.</p>
214<dl class="params"><dt>Parameters</dt><dd>
215  <table class="params">
216    <tr><td class="paramname">position</td><td>position to display the plot </td></tr>
217    <tr><td class="paramname">name</td><td>name </td></tr>
218    <tr><td class="paramname">x_name</td><td>name of x axis </td></tr>
219    <tr><td class="paramname">xmin</td><td>default xmin of the plot </td></tr>
220    <tr><td class="paramname">xmax</td><td>default xmax of the plot </td></tr>
221    <tr><td class="paramname">y_name</td><td>name of y axis </td></tr>
222    <tr><td class="paramname">ymin</td><td>default ymin of the plot </td></tr>
223    <tr><td class="paramname">ymax</td><td>default ymax of the plot </td></tr>
224  </table>
225  </dd>
226</dl>
227
228</div>
229</div>
230<a class="anchor" id="a1bae1723d99ae31d9c1936f782d9ee3e"></a>
231<div class="memitem">
232<div class="memproto">
233      <table class="memname">
234        <tr>
235          <td class="memname">flair::gui::DataPlot2D::~DataPlot2D </td>
236          <td>(</td>
237          <td class="paramname"></td><td>)</td>
238          <td></td>
239        </tr>
240      </table>
241</div><div class="memdoc">
242
243<p>Destructor. </p>
244
245</div>
246</div>
247<h2 class="groupheader">Member Function Documentation</h2>
248<a class="anchor" id="add21a8cf4753bd3329534739cea5073e"></a>
249<div class="memitem">
250<div class="memproto">
251      <table class="memname">
252        <tr>
253          <td class="memname">void flair::gui::DataPlot2D::AddCurve </td>
254          <td>(</td>
255          <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_i_o_data_element.html">core::IODataElement</a> *&#160;</td>
256          <td class="paramname"><em>x_element</em>, </td>
257        </tr>
258        <tr>
259          <td class="paramkey"></td>
260          <td></td>
261          <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_i_o_data_element.html">core::IODataElement</a> *&#160;</td>
262          <td class="paramname"><em>y_element</em>, </td>
263        </tr>
264        <tr>
265          <td class="paramkey"></td>
266          <td></td>
267          <td class="paramtype"><a class="el" href="classflair_1_1gui_1_1_data_plot.html#a0e106271554ff92ebeb94d22014f037e">Color_t</a>&#160;</td>
268          <td class="paramname"><em>color</em>, </td>
269        </tr>
270        <tr>
271          <td class="paramkey"></td>
272          <td></td>
273          <td class="paramtype">std::string&#160;</td>
274          <td class="paramname"><em>curve_name</em> = <code>&quot;&quot;</code>&#160;</td>
275        </tr>
276        <tr>
277          <td></td>
278          <td>)</td>
279          <td></td><td></td>
280        </tr>
281      </table>
282</div><div class="memdoc">
283
284<p>Add a curve from elements to the plot. </p>
285<p>Curve's color can be selected by its name.</p>
286<dl class="params"><dt>Parameters</dt><dd>
287  <table class="params">
288    <tr><td class="paramname">x_element</td><td>element to plot for x coordinate </td></tr>
289    <tr><td class="paramname">y_element</td><td>element to plot for y coordinate </td></tr>
290    <tr><td class="paramname">color</td><td>color of the curve </td></tr>
291    <tr><td class="paramname">curve_name</td><td>name of the curve ofr the legend </td></tr>
292  </table>
293  </dd>
294</dl>
295
296</div>
297</div>
298<a class="anchor" id="a86a4caf997b35f97b97021090bc7be64"></a>
299<div class="memitem">
300<div class="memproto">
301      <table class="memname">
302        <tr>
303          <td class="memname">void flair::gui::DataPlot2D::AddCurve </td>
304          <td>(</td>
305          <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_i_o_data_element.html">core::IODataElement</a> *&#160;</td>
306          <td class="paramname"><em>x_element</em>, </td>
307        </tr>
308        <tr>
309          <td class="paramkey"></td>
310          <td></td>
311          <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_i_o_data_element.html">core::IODataElement</a> *&#160;</td>
312          <td class="paramname"><em>y_element</em>, </td>
313        </tr>
314        <tr>
315          <td class="paramkey"></td>
316          <td></td>
317          <td class="paramtype">uint8_t&#160;</td>
318          <td class="paramname"><em>r</em> = <code>255</code>, </td>
319        </tr>
320        <tr>
321          <td class="paramkey"></td>
322          <td></td>
323          <td class="paramtype">uint8_t&#160;</td>
324          <td class="paramname"><em>g</em> = <code>0</code>, </td>
325        </tr>
326        <tr>
327          <td class="paramkey"></td>
328          <td></td>
329          <td class="paramtype">uint8_t&#160;</td>
330          <td class="paramname"><em>b</em> = <code>0</code>, </td>
331        </tr>
332        <tr>
333          <td class="paramkey"></td>
334          <td></td>
335          <td class="paramtype">std::string&#160;</td>
336          <td class="paramname"><em>curve_name</em> = <code>&quot;&quot;</code>&#160;</td>
337        </tr>
338        <tr>
339          <td></td>
340          <td>)</td>
341          <td></td><td></td>
342        </tr>
343      </table>
344</div><div class="memdoc">
345
346<p>Add a curve from elements to the plot. </p>
347<p>Curve's color can be selected by its RGB components.</p>
348<dl class="params"><dt>Parameters</dt><dd>
349  <table class="params">
350    <tr><td class="paramname">x_element</td><td>element to plot for x coordinate </td></tr>
351    <tr><td class="paramname">y_element</td><td>element to plot for y coordinate </td></tr>
352    <tr><td class="paramname">r</td><td>red component of the curve </td></tr>
353    <tr><td class="paramname">g</td><td>green component of the curve </td></tr>
354    <tr><td class="paramname">b</td><td>blue component of the curve </td></tr>
355    <tr><td class="paramname">curve_name</td><td>name of the curve ofr the legend </td></tr>
356  </table>
357  </dd>
358</dl>
359
360</div>
361</div>
362</div><!-- contents -->
363</div><!-- doc-content -->
364<!-- start footer part -->
365<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
366  <ul>
367    <li class="navelem"><a class="el" href="namespaceflair.html">flair</a></li><li class="navelem"><a class="el" href="namespaceflair_1_1gui.html">gui</a></li><li class="navelem"><a class="el" href="classflair_1_1gui_1_1_data_plot2_d.html">DataPlot2D</a></li>
368    <li class="footer">Generated on Wed Jan 16 2019 09:54:10 for Flair by
369    <a href="http://www.doxygen.org/index.html">
370    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
371  </ul>
372</div>
373</body>
374</html>
Note: See TracBrowser for help on using the repository browser.