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

Last change on this file since 15 was 15, checked in by Sanahuja Guillaume, 5 years ago

m

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