source: flair-dev/trunk/doc/Flair/classflair_1_1gui_1_1_data_plot1_d.html @ 35

Last change on this file since 35 was 35, checked in by Sanahuja Guillaume, 4 years ago

m

File size: 15.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.9.1"/>
7<title>Flair: flair::gui::DataPlot1D 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_plot1_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_plot1_d-members.html">List of all members</a>  </div>
113  <div class="headertitle">
114<div class="title">flair::gui::DataPlot1D Class Reference</div>  </div>
115</div><!--header-->
116<div class="contents">
117
118<p>Class displaying a 1D plot on the ground station. 
119 <a href="classflair_1_1gui_1_1_data_plot1_d.html#details">More...</a></p>
120
121<p><code>#include &lt;<a class="el" href="_data_plot1_d_8h_source.html">DataPlot1D.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::DataPlot1D:</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_plot1_d.png" usemap="#flair::gui::DataPlot1D_map" alt=""/>
129  <map id="flair::gui::DataPlot1D_map" name="flair::gui::DataPlot1D_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:a75fdd0a5c2506ab59de05a7a7de1b10d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_data_plot1_d.html#a75fdd0a5c2506ab59de05a7a7de1b10d">DataPlot1D</a> (const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">LayoutPosition</a> *position, std::string name, float ymin, float ymax)</td></tr>
137<tr class="memdesc:a75fdd0a5c2506ab59de05a7a7de1b10d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a75fdd0a5c2506ab59de05a7a7de1b10d">More...</a><br /></td></tr>
138<tr class="separator:a75fdd0a5c2506ab59de05a7a7de1b10d"><td class="memSeparator" colspan="2">&#160;</td></tr>
139<tr class="memitem:a418a2533a0ebb0bdd09c3f6a731d121d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_data_plot1_d.html#a418a2533a0ebb0bdd09c3f6a731d121d">~DataPlot1D</a> ()</td></tr>
140<tr class="memdesc:a418a2533a0ebb0bdd09c3f6a731d121d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a418a2533a0ebb0bdd09c3f6a731d121d">More...</a><br /></td></tr>
141<tr class="separator:a418a2533a0ebb0bdd09c3f6a731d121d"><td class="memSeparator" colspan="2">&#160;</td></tr>
142<tr class="memitem:ab0837bfa0a3423c8ef25bf6cf1c2ba76"><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_plot1_d.html#ab0837bfa0a3423c8ef25bf6cf1c2ba76">AddCurve</a> (const <a class="el" href="classflair_1_1core_1_1_i_o_data_element.html">core::IODataElement</a> *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:ab0837bfa0a3423c8ef25bf6cf1c2ba76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a curve from an IODataElement to the plot.  <a href="#ab0837bfa0a3423c8ef25bf6cf1c2ba76">More...</a><br /></td></tr>
144<tr class="separator:ab0837bfa0a3423c8ef25bf6cf1c2ba76"><td class="memSeparator" colspan="2">&#160;</td></tr>
145<tr class="memitem:ae3a47f720e4922ee6dd82a57279a3469"><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_plot1_d.html#ae3a47f720e4922ee6dd82a57279a3469">AddCurve</a> (const <a class="el" href="classflair_1_1core_1_1_i_o_data_element.html">core::IODataElement</a> *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:ae3a47f720e4922ee6dd82a57279a3469"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a curve from an IODataElement to the plot.  <a href="#ae3a47f720e4922ee6dd82a57279a3469">More...</a><br /></td></tr>
147<tr class="separator:ae3a47f720e4922ee6dd82a57279a3469"><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 1D plot on the ground station. </p>
151</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
152<a class="anchor" id="a75fdd0a5c2506ab59de05a7a7de1b10d"></a>
153<div class="memitem">
154<div class="memproto">
155      <table class="memname">
156        <tr>
157          <td class="memname">flair::gui::DataPlot1D::DataPlot1D </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">float&#160;</td>
172          <td class="paramname"><em>ymin</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>ymax</em>&#160;</td>
179        </tr>
180        <tr>
181          <td></td>
182          <td>)</td>
183          <td></td><td></td>
184        </tr>
185      </table>
186</div><div class="memdoc">
187
188<p>Constructor. </p>
189<p>Construct a 1D plot at given position.</p>
190<dl class="params"><dt>Parameters</dt><dd>
191  <table class="params">
192    <tr><td class="paramname">position</td><td>position to display the plot </td></tr>
193    <tr><td class="paramname">name</td><td>name </td></tr>
194    <tr><td class="paramname">ymin</td><td>default ymin of the plot </td></tr>
195    <tr><td class="paramname">ymax</td><td>default ymax of the plot </td></tr>
196  </table>
197  </dd>
198</dl>
199
200</div>
201</div>
202<a class="anchor" id="a418a2533a0ebb0bdd09c3f6a731d121d"></a>
203<div class="memitem">
204<div class="memproto">
205      <table class="memname">
206        <tr>
207          <td class="memname">flair::gui::DataPlot1D::~DataPlot1D </td>
208          <td>(</td>
209          <td class="paramname"></td><td>)</td>
210          <td></td>
211        </tr>
212      </table>
213</div><div class="memdoc">
214
215<p>Destructor. </p>
216
217</div>
218</div>
219<h2 class="groupheader">Member Function Documentation</h2>
220<a class="anchor" id="ab0837bfa0a3423c8ef25bf6cf1c2ba76"></a>
221<div class="memitem">
222<div class="memproto">
223      <table class="memname">
224        <tr>
225          <td class="memname">void flair::gui::DataPlot1D::AddCurve </td>
226          <td>(</td>
227          <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_i_o_data_element.html">core::IODataElement</a> *&#160;</td>
228          <td class="paramname"><em>element</em>, </td>
229        </tr>
230        <tr>
231          <td class="paramkey"></td>
232          <td></td>
233          <td class="paramtype"><a class="el" href="classflair_1_1gui_1_1_data_plot.html#a0e106271554ff92ebeb94d22014f037e">Color_t</a>&#160;</td>
234          <td class="paramname"><em>color</em>, </td>
235        </tr>
236        <tr>
237          <td class="paramkey"></td>
238          <td></td>
239          <td class="paramtype">std::string&#160;</td>
240          <td class="paramname"><em>curve_name</em> = <code>&quot;&quot;</code>&#160;</td>
241        </tr>
242        <tr>
243          <td></td>
244          <td>)</td>
245          <td></td><td></td>
246        </tr>
247      </table>
248</div><div class="memdoc">
249
250<p>Add a curve from an IODataElement to the plot. </p>
251<p>Curve's color can be selected by its name.</p>
252<dl class="params"><dt>Parameters</dt><dd>
253  <table class="params">
254    <tr><td class="paramname">element</td><td>element to plot </td></tr>
255    <tr><td class="paramname">color</td><td>color of the curve </td></tr>
256    <tr><td class="paramname">curve_name</td><td>name of the curve for the legend, if unspecified, element-&gt;<a class="el" href="classflair_1_1core_1_1_object.html#a9b0344dff7e1c05424d9152c8274523a" title="Name. ">ObjectName()</a> will be used </td></tr>
257  </table>
258  </dd>
259</dl>
260
261</div>
262</div>
263<a class="anchor" id="ae3a47f720e4922ee6dd82a57279a3469"></a>
264<div class="memitem">
265<div class="memproto">
266      <table class="memname">
267        <tr>
268          <td class="memname">void flair::gui::DataPlot1D::AddCurve </td>
269          <td>(</td>
270          <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_i_o_data_element.html">core::IODataElement</a> *&#160;</td>
271          <td class="paramname"><em>element</em>, </td>
272        </tr>
273        <tr>
274          <td class="paramkey"></td>
275          <td></td>
276          <td class="paramtype">uint8_t&#160;</td>
277          <td class="paramname"><em>r</em> = <code>255</code>, </td>
278        </tr>
279        <tr>
280          <td class="paramkey"></td>
281          <td></td>
282          <td class="paramtype">uint8_t&#160;</td>
283          <td class="paramname"><em>g</em> = <code>0</code>, </td>
284        </tr>
285        <tr>
286          <td class="paramkey"></td>
287          <td></td>
288          <td class="paramtype">uint8_t&#160;</td>
289          <td class="paramname"><em>b</em> = <code>0</code>, </td>
290        </tr>
291        <tr>
292          <td class="paramkey"></td>
293          <td></td>
294          <td class="paramtype">std::string&#160;</td>
295          <td class="paramname"><em>curve_name</em> = <code>&quot;&quot;</code>&#160;</td>
296        </tr>
297        <tr>
298          <td></td>
299          <td>)</td>
300          <td></td><td></td>
301        </tr>
302      </table>
303</div><div class="memdoc">
304
305<p>Add a curve from an IODataElement to the plot. </p>
306<p>Curve's color can be selected by its RGB components.</p>
307<dl class="params"><dt>Parameters</dt><dd>
308  <table class="params">
309    <tr><td class="paramname">element</td><td>element to plot </td></tr>
310    <tr><td class="paramname">r</td><td>red component of the curve </td></tr>
311    <tr><td class="paramname">g</td><td>green component of the curve </td></tr>
312    <tr><td class="paramname">b</td><td>blue component of the curve </td></tr>
313    <tr><td class="paramname">curve_name</td><td>name of the curve for the legend, if unspecified, element-&gt;<a class="el" href="classflair_1_1core_1_1_object.html#a9b0344dff7e1c05424d9152c8274523a" title="Name. ">ObjectName()</a> will be used </td></tr>
314  </table>
315  </dd>
316</dl>
317
318</div>
319</div>
320</div><!-- contents -->
321</div><!-- doc-content -->
322<!-- start footer part -->
323<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
324  <ul>
325    <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_plot1_d.html">DataPlot1D</a></li>
326    <li class="footer">Generated on Wed Sep 28 2016 07:01:52 for Flair by
327    <a href="http://www.doxygen.org/index.html">
328    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
329  </ul>
330</div>
331</body>
332</html>
Note: See TracBrowser for help on using the repository browser.