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

Last change on this file was 100, checked in by Sanahuja Guillaume, 22 months ago

doc

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