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

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

m

File size: 15.7 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::core::cvmatrix_descriptor 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_1core_1_1cvmatrix__descriptor.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_1core_1_1cvmatrix__descriptor-members.html">List of all members</a>  </div>
111  <div class="headertitle">
112<div class="title">flair::core::cvmatrix_descriptor Class Reference</div>  </div>
113</div><!--header-->
114<div class="contents">
115
116<p>Class describing cvmatrix elements, for log and graphs purpose. 
117 <a href="classflair_1_1core_1_1cvmatrix__descriptor.html#details">More...</a></p>
118
119<p><code>#include &lt;<a class="el" href="cvmatrix__descriptor_8h_source.html">cvmatrix_descriptor.h</a>&gt;</code></p>
120<table class="memberdecls">
121<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
122Public Member Functions</h2></td></tr>
123<tr class="memitem:abe29e1334e98f2581a7f3c4d2dba3211"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1cvmatrix__descriptor.html#abe29e1334e98f2581a7f3c4d2dba3211">cvmatrix_descriptor</a> (uint32_t rows, uint32_t cols)</td></tr>
124<tr class="memdesc:abe29e1334e98f2581a7f3c4d2dba3211"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#abe29e1334e98f2581a7f3c4d2dba3211">More...</a><br /></td></tr>
125<tr class="separator:abe29e1334e98f2581a7f3c4d2dba3211"><td class="memSeparator" colspan="2">&#160;</td></tr>
126<tr class="memitem:a1abe66646468d9bf743d21adc028eaf3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1cvmatrix__descriptor.html#a1abe66646468d9bf743d21adc028eaf3">~cvmatrix_descriptor</a> ()</td></tr>
127<tr class="memdesc:a1abe66646468d9bf743d21adc028eaf3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a1abe66646468d9bf743d21adc028eaf3">More...</a><br /></td></tr>
128<tr class="separator:a1abe66646468d9bf743d21adc028eaf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
129<tr class="memitem:a6b68acb9a1db79573780370c54b6d077"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1cvmatrix__descriptor.html#a6b68acb9a1db79573780370c54b6d077">SetElementName</a> (uint32_t row, uint32_t col, std::string name)</td></tr>
130<tr class="memdesc:a6b68acb9a1db79573780370c54b6d077"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set element name.  <a href="#a6b68acb9a1db79573780370c54b6d077">More...</a><br /></td></tr>
131<tr class="separator:a6b68acb9a1db79573780370c54b6d077"><td class="memSeparator" colspan="2">&#160;</td></tr>
132<tr class="memitem:a6bb368cea0ea8e947446d4d468f0a7bc"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1cvmatrix__descriptor.html#a6bb368cea0ea8e947446d4d468f0a7bc">ElementName</a> (uint32_t row, uint32_t col) const </td></tr>
133<tr class="memdesc:a6bb368cea0ea8e947446d4d468f0a7bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Element name.  <a href="#a6bb368cea0ea8e947446d4d468f0a7bc">More...</a><br /></td></tr>
134<tr class="separator:a6bb368cea0ea8e947446d4d468f0a7bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
135<tr class="memitem:af29d7a83feaaa169ba44719165b3f85b"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1cvmatrix__descriptor.html#af29d7a83feaaa169ba44719165b3f85b">Rows</a> (void) const </td></tr>
136<tr class="memdesc:af29d7a83feaaa169ba44719165b3f85b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of rows.  <a href="#af29d7a83feaaa169ba44719165b3f85b">More...</a><br /></td></tr>
137<tr class="separator:af29d7a83feaaa169ba44719165b3f85b"><td class="memSeparator" colspan="2">&#160;</td></tr>
138<tr class="memitem:ab27faf7fde9bbe28037e7f7e435cc7c8"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1cvmatrix__descriptor.html#ab27faf7fde9bbe28037e7f7e435cc7c8">Cols</a> (void) const </td></tr>
139<tr class="memdesc:ab27faf7fde9bbe28037e7f7e435cc7c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of colomns.  <a href="#ab27faf7fde9bbe28037e7f7e435cc7c8">More...</a><br /></td></tr>
140<tr class="separator:ab27faf7fde9bbe28037e7f7e435cc7c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
141</table>
142<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
143<div class="textblock"><p>Class describing cvmatrix elements, for log and graphs purpose. </p>
144<p>This class allows to give a name to matrix elements. These names will be used in graphs and logs. </p>
145</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
146<a class="anchor" id="abe29e1334e98f2581a7f3c4d2dba3211"></a>
147<div class="memitem">
148<div class="memproto">
149      <table class="memname">
150        <tr>
151          <td class="memname">flair::core::cvmatrix_descriptor::cvmatrix_descriptor </td>
152          <td>(</td>
153          <td class="paramtype">uint32_t&#160;</td>
154          <td class="paramname"><em>rows</em>, </td>
155        </tr>
156        <tr>
157          <td class="paramkey"></td>
158          <td></td>
159          <td class="paramtype">uint32_t&#160;</td>
160          <td class="paramname"><em>cols</em>&#160;</td>
161        </tr>
162        <tr>
163          <td></td>
164          <td>)</td>
165          <td></td><td></td>
166        </tr>
167      </table>
168</div><div class="memdoc">
169
170<p>Constructor. </p>
171<p>Construct a matrix descriptor.</p>
172<dl class="params"><dt>Parameters</dt><dd>
173  <table class="params">
174    <tr><td class="paramname">rows</td><td>matrix rows </td></tr>
175    <tr><td class="paramname">cols</td><td>matrix cols </td></tr>
176  </table>
177  </dd>
178</dl>
179
180</div>
181</div>
182<a class="anchor" id="a1abe66646468d9bf743d21adc028eaf3"></a>
183<div class="memitem">
184<div class="memproto">
185      <table class="memname">
186        <tr>
187          <td class="memname">flair::core::cvmatrix_descriptor::~cvmatrix_descriptor </td>
188          <td>(</td>
189          <td class="paramname"></td><td>)</td>
190          <td></td>
191        </tr>
192      </table>
193</div><div class="memdoc">
194
195<p>Destructor. </p>
196
197</div>
198</div>
199<h2 class="groupheader">Member Function Documentation</h2>
200<a class="anchor" id="a6b68acb9a1db79573780370c54b6d077"></a>
201<div class="memitem">
202<div class="memproto">
203      <table class="memname">
204        <tr>
205          <td class="memname">void flair::core::cvmatrix_descriptor::SetElementName </td>
206          <td>(</td>
207          <td class="paramtype">uint32_t&#160;</td>
208          <td class="paramname"><em>row</em>, </td>
209        </tr>
210        <tr>
211          <td class="paramkey"></td>
212          <td></td>
213          <td class="paramtype">uint32_t&#160;</td>
214          <td class="paramname"><em>col</em>, </td>
215        </tr>
216        <tr>
217          <td class="paramkey"></td>
218          <td></td>
219          <td class="paramtype">std::string&#160;</td>
220          <td class="paramname"><em>name</em>&#160;</td>
221        </tr>
222        <tr>
223          <td></td>
224          <td>)</td>
225          <td></td><td></td>
226        </tr>
227      </table>
228</div><div class="memdoc">
229
230<p>Set element name. </p>
231<dl class="params"><dt>Parameters</dt><dd>
232  <table class="params">
233    <tr><td class="paramname">row</td><td>element row </td></tr>
234    <tr><td class="paramname">col</td><td>element col </td></tr>
235    <tr><td class="paramname">name</td><td>element name </td></tr>
236  </table>
237  </dd>
238</dl>
239
240</div>
241</div>
242<a class="anchor" id="a6bb368cea0ea8e947446d4d468f0a7bc"></a>
243<div class="memitem">
244<div class="memproto">
245      <table class="memname">
246        <tr>
247          <td class="memname">std::string flair::core::cvmatrix_descriptor::ElementName </td>
248          <td>(</td>
249          <td class="paramtype">uint32_t&#160;</td>
250          <td class="paramname"><em>row</em>, </td>
251        </tr>
252        <tr>
253          <td class="paramkey"></td>
254          <td></td>
255          <td class="paramtype">uint32_t&#160;</td>
256          <td class="paramname"><em>col</em>&#160;</td>
257        </tr>
258        <tr>
259          <td></td>
260          <td>)</td>
261          <td></td><td> const</td>
262        </tr>
263      </table>
264</div><div class="memdoc">
265
266<p>Element name. </p>
267<dl class="params"><dt>Parameters</dt><dd>
268  <table class="params">
269    <tr><td class="paramname">row</td><td>element row </td></tr>
270    <tr><td class="paramname">col</td><td>element col</td></tr>
271  </table>
272  </dd>
273</dl>
274<dl class="section return"><dt>Returns</dt><dd>element name </dd></dl>
275
276</div>
277</div>
278<a class="anchor" id="af29d7a83feaaa169ba44719165b3f85b"></a>
279<div class="memitem">
280<div class="memproto">
281      <table class="memname">
282        <tr>
283          <td class="memname">uint32_t flair::core::cvmatrix_descriptor::Rows </td>
284          <td>(</td>
285          <td class="paramtype">void&#160;</td>
286          <td class="paramname"></td><td>)</td>
287          <td> const</td>
288        </tr>
289      </table>
290</div><div class="memdoc">
291
292<p>Number of rows. </p>
293<dl class="section return"><dt>Returns</dt><dd>rows </dd></dl>
294
295</div>
296</div>
297<a class="anchor" id="ab27faf7fde9bbe28037e7f7e435cc7c8"></a>
298<div class="memitem">
299<div class="memproto">
300      <table class="memname">
301        <tr>
302          <td class="memname">uint32_t flair::core::cvmatrix_descriptor::Cols </td>
303          <td>(</td>
304          <td class="paramtype">void&#160;</td>
305          <td class="paramname"></td><td>)</td>
306          <td> const</td>
307        </tr>
308      </table>
309</div><div class="memdoc">
310
311<p>Number of colomns. </p>
312<dl class="section return"><dt>Returns</dt><dd>colomns </dd></dl>
313
314</div>
315</div>
316</div><!-- contents -->
317</div><!-- doc-content -->
318<!-- start footer part -->
319<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
320  <ul>
321    <li class="navelem"><a class="el" href="namespaceflair.html">flair</a></li><li class="navelem"><a class="el" href="namespaceflair_1_1core.html">core</a></li><li class="navelem"><a class="el" href="classflair_1_1core_1_1cvmatrix__descriptor.html">cvmatrix_descriptor</a></li>
322    <li class="footer">Generated on Wed Apr 20 2016 16:16:00 for Flair by
323    <a href="http://www.doxygen.org/index.html">
324    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
325  </ul>
326</div>
327</body>
328</html>
Note: See TracBrowser for help on using the repository browser.