source: flair-dev/trunk/doc/Flair/classflair_1_1core_1_1_framework_manager.html @ 27

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

m

File size: 40.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::core::FrameworkManager 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_1_framework_manager.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_1_framework_manager-members.html">List of all members</a>  </div>
113  <div class="headertitle">
114<div class="title">flair::core::FrameworkManager Class Reference</div>  </div>
115</div><!--header-->
116<div class="contents">
117
118<p>Main class of the Framework library. 
119 <a href="classflair_1_1core_1_1_framework_manager.html#details">More...</a></p>
120
121<p><code>#include &lt;<a class="el" href="_framework_manager_8h_source.html">FrameworkManager.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::core::FrameworkManager:</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_1core_1_1_framework_manager.png" usemap="#flair::core::FrameworkManager_map" alt=""/>
129  <map id="flair::core::FrameworkManager_map" name="flair::core::FrameworkManager_map">
130<area href="classflair_1_1core_1_1_object.html" title="Base class for all Framework&#39;s classes. " alt="flair::core::Object" shape="rect" coords="0,0,186,24"/>
131<area href="classflair_1_1simulator_1_1_simulator.html" alt="flair::simulator::Simulator" shape="rect" coords="0,112,186,136"/>
132</map>
133 </div></div>
134<table class="memberdecls">
135<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
136Public Member Functions</h2></td></tr>
137<tr class="memitem:ac4488013eb79fb1cd0c57fe4774120ae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_framework_manager.html#ac4488013eb79fb1cd0c57fe4774120ae">FrameworkManager</a> (std::string name)</td></tr>
138<tr class="memdesc:ac4488013eb79fb1cd0c57fe4774120ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ac4488013eb79fb1cd0c57fe4774120ae">More...</a><br /></td></tr>
139<tr class="separator:ac4488013eb79fb1cd0c57fe4774120ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
140<tr class="memitem:aa97c7fbaba572aa856d23c416f3b74e4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_framework_manager.html#aa97c7fbaba572aa856d23c416f3b74e4">~FrameworkManager</a> ()</td></tr>
141<tr class="memdesc:aa97c7fbaba572aa856d23c416f3b74e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#aa97c7fbaba572aa856d23c416f3b74e4">More...</a><br /></td></tr>
142<tr class="separator:aa97c7fbaba572aa856d23c416f3b74e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
143<tr class="memitem:ab2a2ea16b7d5558ac24c24476eb5116f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_framework_manager.html#ab2a2ea16b7d5558ac24c24476eb5116f">SetupConnection</a> (std::string address, uint16_t port, size_t rcv_buf_size=10000)</td></tr>
144<tr class="memdesc:ab2a2ea16b7d5558ac24c24476eb5116f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setup the connection with ground station.  <a href="#ab2a2ea16b7d5558ac24c24476eb5116f">More...</a><br /></td></tr>
145<tr class="separator:ab2a2ea16b7d5558ac24c24476eb5116f"><td class="memSeparator" colspan="2">&#160;</td></tr>
146<tr class="memitem:a528ab69c3a850237007a074732d9fa85"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_framework_manager.html#a528ab69c3a850237007a074732d9fa85">SetupUserInterface</a> (std::string xml_file)</td></tr>
147<tr class="memdesc:a528ab69c3a850237007a074732d9fa85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setup the user interface.  <a href="#a528ab69c3a850237007a074732d9fa85">More...</a><br /></td></tr>
148<tr class="separator:a528ab69c3a850237007a074732d9fa85"><td class="memSeparator" colspan="2">&#160;</td></tr>
149<tr class="memitem:a8f3989b0199826a913f352cc1e26f86b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classflair_1_1gui_1_1_tab_widget.html">gui::TabWidget</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_framework_manager.html#a8f3989b0199826a913f352cc1e26f86b">GetTabWidget</a> (void) const </td></tr>
150<tr class="memdesc:a8f3989b0199826a913f352cc1e26f86b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get TabWidget.  <a href="#a8f3989b0199826a913f352cc1e26f86b">More...</a><br /></td></tr>
151<tr class="separator:a8f3989b0199826a913f352cc1e26f86b"><td class="memSeparator" colspan="2">&#160;</td></tr>
152<tr class="memitem:ac0b1886b695379518bfeff9142d32405"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_framework_manager.html#ac0b1886b695379518bfeff9142d32405">SetupLogger</a> (std::string log_path)</td></tr>
153<tr class="memdesc:ac0b1886b695379518bfeff9142d32405"><td class="mdescLeft">&#160;</td><td class="mdescRight">Logger setup.  <a href="#ac0b1886b695379518bfeff9142d32405">More...</a><br /></td></tr>
154<tr class="separator:ac0b1886b695379518bfeff9142d32405"><td class="memSeparator" colspan="2">&#160;</td></tr>
155<tr class="memitem:a9f2750ce913b492206761340c666bbb6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_framework_manager.html#a9f2750ce913b492206761340c666bbb6">AddDeviceToLog</a> (<a class="el" href="classflair_1_1core_1_1_i_o_device.html">IODevice</a> *device)</td></tr>
156<tr class="memdesc:a9f2750ce913b492206761340c666bbb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add log element.  <a href="#a9f2750ce913b492206761340c666bbb6">More...</a><br /></td></tr>
157<tr class="separator:a9f2750ce913b492206761340c666bbb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
158<tr class="memitem:a1cbc5e8296c0f36551210e13251516ae"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_framework_manager.html#a1cbc5e8296c0f36551210e13251516ae">StartLog</a> (void)</td></tr>
159<tr class="memdesc:a1cbc5e8296c0f36551210e13251516ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start logging.  <a href="#a1cbc5e8296c0f36551210e13251516ae">More...</a><br /></td></tr>
160<tr class="separator:a1cbc5e8296c0f36551210e13251516ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
161<tr class="memitem:a978aae4beac0c20dbbff73369ab6e31a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_framework_manager.html#a978aae4beac0c20dbbff73369ab6e31a">StopLog</a> (void)</td></tr>
162<tr class="memdesc:a978aae4beac0c20dbbff73369ab6e31a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop logging.  <a href="#a978aae4beac0c20dbbff73369ab6e31a">More...</a><br /></td></tr>
163<tr class="separator:a978aae4beac0c20dbbff73369ab6e31a"><td class="memSeparator" colspan="2">&#160;</td></tr>
164<tr class="memitem:a65eff6c3651dafddc2dd55c3cab281b4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_framework_manager.html#a65eff6c3651dafddc2dd55c3cab281b4">IsLogging</a> (void) const </td></tr>
165<tr class="memdesc:a65eff6c3651dafddc2dd55c3cab281b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is logging?  <a href="#a65eff6c3651dafddc2dd55c3cab281b4">More...</a><br /></td></tr>
166<tr class="separator:a65eff6c3651dafddc2dd55c3cab281b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
167<tr class="memitem:a6ed9bdb73288176aa58269f8a520d58c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_framework_manager.html#a6ed9bdb73288176aa58269f8a520d58c">UpdateSendData</a> (const <a class="el" href="classflair_1_1gui_1_1_send_data.html">gui::SendData</a> *obj)</td></tr>
168<tr class="memdesc:a6ed9bdb73288176aa58269f8a520d58c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notify that SendData's period has changed.  <a href="#a6ed9bdb73288176aa58269f8a520d58c">More...</a><br /></td></tr>
169<tr class="separator:a6ed9bdb73288176aa58269f8a520d58c"><td class="memSeparator" colspan="2">&#160;</td></tr>
170<tr class="memitem:aa1b6474b3972665d20c706ff89965271"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_framework_manager.html#aa1b6474b3972665d20c706ff89965271">BlockCom</a> (void)</td></tr>
171<tr class="memdesc:aa1b6474b3972665d20c706ff89965271"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block communication.  <a href="#aa1b6474b3972665d20c706ff89965271">More...</a><br /></td></tr>
172<tr class="separator:aa1b6474b3972665d20c706ff89965271"><td class="memSeparator" colspan="2">&#160;</td></tr>
173<tr class="memitem:a311fa9be9c08b037cae24061e85307d1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_framework_manager.html#a311fa9be9c08b037cae24061e85307d1">UnBlockCom</a> (void)</td></tr>
174<tr class="memdesc:a311fa9be9c08b037cae24061e85307d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unblock communication.  <a href="#a311fa9be9c08b037cae24061e85307d1">More...</a><br /></td></tr>
175<tr class="separator:a311fa9be9c08b037cae24061e85307d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
176<tr class="memitem:a845ac3ad0cbc95d71e50277d9e8093a1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_framework_manager.html#a845ac3ad0cbc95d71e50277d9e8093a1">ConnectionLost</a> (void) const </td></tr>
177<tr class="memdesc:a845ac3ad0cbc95d71e50277d9e8093a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is connection lost?  <a href="#a845ac3ad0cbc95d71e50277d9e8093a1">More...</a><br /></td></tr>
178<tr class="separator:a845ac3ad0cbc95d71e50277d9e8093a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
179<tr class="memitem:a69e12f51081a3d58876553d9858ea1bd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_framework_manager.html#a69e12f51081a3d58876553d9858ea1bd">DisableErrorsDisplay</a> (bool value)</td></tr>
180<tr class="memdesc:a69e12f51081a3d58876553d9858ea1bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable errors display.  <a href="#a69e12f51081a3d58876553d9858ea1bd">More...</a><br /></td></tr>
181<tr class="separator:a69e12f51081a3d58876553d9858ea1bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
182<tr class="memitem:a477b3cee8fa2c2338896006faaeefe42"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_framework_manager.html#a477b3cee8fa2c2338896006faaeefe42">IsDisplayingErrors</a> (void) const </td></tr>
183<tr class="memdesc:a477b3cee8fa2c2338896006faaeefe42"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is displaying errors?  <a href="#a477b3cee8fa2c2338896006faaeefe42">More...</a><br /></td></tr>
184<tr class="separator:a477b3cee8fa2c2338896006faaeefe42"><td class="memSeparator" colspan="2">&#160;</td></tr>
185<tr class="inherit_header pub_methods_classflair_1_1core_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1core_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
186<tr class="memitem:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#aec92383fd5bf68d9df10414862b7e95c">Object</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent=NULL, std::string name=&quot;&quot;, std::string type=&quot;&quot;)</td></tr>
187<tr class="memdesc:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#aec92383fd5bf68d9df10414862b7e95c">More...</a><br /></td></tr>
188<tr class="separator:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
189<tr class="memitem:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#aa2bde0e6677bbef705c96c93cb06ad09">~Object</a> ()</td></tr>
190<tr class="memdesc:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#aa2bde0e6677bbef705c96c93cb06ad09">More...</a><br /></td></tr>
191<tr class="separator:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
192<tr class="memitem:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a9b0344dff7e1c05424d9152c8274523a">ObjectName</a> (void) const </td></tr>
193<tr class="memdesc:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name.  <a href="#a9b0344dff7e1c05424d9152c8274523a">More...</a><br /></td></tr>
194<tr class="separator:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
195<tr class="memitem:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a609a250ec037fbcaf8957c8f1dcbfc53">ObjectType</a> (void) const </td></tr>
196<tr class="memdesc:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type.  <a href="#a609a250ec037fbcaf8957c8f1dcbfc53">More...</a><br /></td></tr>
197<tr class="separator:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
198<tr class="memitem:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a360c112cc3017a5152ebf6e84d2efa70">Parent</a> (void) const </td></tr>
199<tr class="memdesc:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parent.  <a href="#a360c112cc3017a5152ebf6e84d2efa70">More...</a><br /></td></tr>
200<tr class="separator:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
201<tr class="memitem:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::vector&lt; const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#ae22db4d723ec2d50b3ba48f26a6a770c">TypeChilds</a> (void) const </td></tr>
202<tr class="memdesc:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Childs of the same type.  <a href="#ae22db4d723ec2d50b3ba48f26a6a770c">More...</a><br /></td></tr>
203<tr class="separator:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
204<tr class="memitem:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::vector&lt; const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a344f81cd35805a9501098bf727ac1a10">Childs</a> (void) const </td></tr>
205<tr class="memdesc:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Childs.  <a href="#a344f81cd35805a9501098bf727ac1a10">More...</a><br /></td></tr>
206<tr class="separator:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
207<tr class="memitem:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#af001feba14fc053aa778e61080a0b4cf">Information</a> (const char *function, int line, const char *format,...) const </td></tr>
208<tr class="memdesc:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted information.  <a href="#af001feba14fc053aa778e61080a0b4cf">More...</a><br /></td></tr>
209<tr class="separator:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
210<tr class="memitem:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a168b18451b2ee6126e1e81d452005ff6">Warning</a> (const char *function, const char *format,...) const </td></tr>
211<tr class="memdesc:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted warning.  <a href="#a168b18451b2ee6126e1e81d452005ff6">More...</a><br /></td></tr>
212<tr class="separator:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
213<tr class="memitem:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a3ca9694d29ec2b0491739879685df5ca">Error</a> (const char *function, const char *format,...) const </td></tr>
214<tr class="memdesc:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted error.  <a href="#a3ca9694d29ec2b0491739879685df5ca">More...</a><br /></td></tr>
215<tr class="separator:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
216<tr class="memitem:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a36cdd7f556e78b1bddd1d1fe4264bb85">ErrorOccured</a> (bool recursive=true) const </td></tr>
217<tr class="memdesc:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has an errror occured?  <a href="#a36cdd7f556e78b1bddd1d1fe4264bb85">More...</a><br /></td></tr>
218<tr class="separator:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
219</table><table class="memberdecls">
220<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
221Additional Inherited Members</h2></td></tr>
222<tr class="inherit_header pub_types_classflair_1_1core_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classflair_1_1core_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
223<tr class="memitem:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed5fccda511f97487040fed29f4efc97"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>color_t</b> { <b>Auto</b> = 0,
224<b>Red</b> = 31,
225<b>Green</b> = 32,
226<b>Orange</b> = 33
227 }</td></tr>
228<tr class="separator:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
229</table>
230<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
231<div class="textblock"><p>Main class of the Framework library. </p>
232<p>This is the main class of the library. Only one instance of this class is allowed by program. Morevoer, its name must be unique if more than one program using this class is running on the same system (a control and a simlator for example). <br />
233 This class allows: <br />
234 -connexion with ground station, <br />
235 -creation of a <a class="elRef" target="_blank" doxygen="/home/gsanahuj/igep/flair-dev/doc/qt.tag:http://qt-project.org/doc/qt-4.8/" href="http://qt-project.org/doc/qt-4.8/qtabwidget.html">QTabWidget</a> on ground station, <br />
236 -handling of xml files, used for default values of Widgets, <br />
237 -logging of datas. </p>
238</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
239<a class="anchor" id="ac4488013eb79fb1cd0c57fe4774120ae"></a>
240<div class="memitem">
241<div class="memproto">
242      <table class="memname">
243        <tr>
244          <td class="memname">flair::core::FrameworkManager::FrameworkManager </td>
245          <td>(</td>
246          <td class="paramtype">std::string&#160;</td>
247          <td class="paramname"><em>name</em></td><td>)</td>
248          <td></td>
249        </tr>
250      </table>
251</div><div class="memdoc">
252
253<p>Constructor. </p>
254<p>Construct a <a class="el" href="classflair_1_1core_1_1_framework_manager.html" title="Main class of the Framework library. ">FrameworkManager</a>. <br />
255 Call SetupConnection method just after this constructor to setup the conection with a ground station.</p>
256<dl class="params"><dt>Parameters</dt><dd>
257  <table class="params">
258    <tr><td class="paramname">name</td><td>name, must be unique </td></tr>
259  </table>
260  </dd>
261</dl>
262
263</div>
264</div>
265<a class="anchor" id="aa97c7fbaba572aa856d23c416f3b74e4"></a>
266<div class="memitem">
267<div class="memproto">
268      <table class="memname">
269        <tr>
270          <td class="memname">flair::core::FrameworkManager::~FrameworkManager </td>
271          <td>(</td>
272          <td class="paramname"></td><td>)</td>
273          <td></td>
274        </tr>
275      </table>
276</div><div class="memdoc">
277
278<p>Destructor. </p>
279<p>Calling it will automatically destruct all childs. <br />
280Destruction implies destruction of the <a class="elRef" target="_blank" doxygen="/home/gsanahuj/igep/flair-dev/doc/qt.tag:http://qt-project.org/doc/qt-4.8/" href="http://qt-project.org/doc/qt-4.8/qtabwidget.html">QTabWidget</a> on ground station. </p>
281
282</div>
283</div>
284<h2 class="groupheader">Member Function Documentation</h2>
285<a class="anchor" id="ab2a2ea16b7d5558ac24c24476eb5116f"></a>
286<div class="memitem">
287<div class="memproto">
288      <table class="memname">
289        <tr>
290          <td class="memname">void flair::core::FrameworkManager::SetupConnection </td>
291          <td>(</td>
292          <td class="paramtype">std::string&#160;</td>
293          <td class="paramname"><em>address</em>, </td>
294        </tr>
295        <tr>
296          <td class="paramkey"></td>
297          <td></td>
298          <td class="paramtype">uint16_t&#160;</td>
299          <td class="paramname"><em>port</em>, </td>
300        </tr>
301        <tr>
302          <td class="paramkey"></td>
303          <td></td>
304          <td class="paramtype">size_t&#160;</td>
305          <td class="paramname"><em>rcv_buf_size</em> = <code>10000</code>&#160;</td>
306        </tr>
307        <tr>
308          <td></td>
309          <td>)</td>
310          <td></td><td></td>
311        </tr>
312      </table>
313</div><div class="memdoc">
314
315<p>Setup the connection with ground station. </p>
316<p>Call this method just after the constructor of this class. If this method is not called, the program will run headless.</p>
317<dl class="params"><dt>Parameters</dt><dd>
318  <table class="params">
319    <tr><td class="paramname">address</td><td>address of ground station </td></tr>
320    <tr><td class="paramname">port</td><td>port of ground station </td></tr>
321    <tr><td class="paramname">rcv_buf_size</td><td>receive buffer size </td></tr>
322  </table>
323  </dd>
324</dl>
325
326</div>
327</div>
328<a class="anchor" id="a528ab69c3a850237007a074732d9fa85"></a>
329<div class="memitem">
330<div class="memproto">
331      <table class="memname">
332        <tr>
333          <td class="memname">void flair::core::FrameworkManager::SetupUserInterface </td>
334          <td>(</td>
335          <td class="paramtype">std::string&#160;</td>
336          <td class="paramname"><em>xml_file</em></td><td>)</td>
337          <td></td>
338        </tr>
339      </table>
340</div><div class="memdoc">
341
342<p>Setup the user interface. </p>
343<p>If this method is called after SetupConnection, Widgets will be displayed in the ground station. Otherwise, it will run headless, but default values of Widgets will be taken from the xml file.</p>
344<dl class="params"><dt>Parameters</dt><dd>
345  <table class="params">
346    <tr><td class="paramname">xml_file</td><td>xml file for default values of Widgets </td></tr>
347  </table>
348  </dd>
349</dl>
350
351</div>
352</div>
353<a class="anchor" id="a8f3989b0199826a913f352cc1e26f86b"></a>
354<div class="memitem">
355<div class="memproto">
356      <table class="memname">
357        <tr>
358          <td class="memname"><a class="el" href="classflair_1_1gui_1_1_tab_widget.html">gui::TabWidget</a>* flair::core::FrameworkManager::GetTabWidget </td>
359          <td>(</td>
360          <td class="paramtype">void&#160;</td>
361          <td class="paramname"></td><td>)</td>
362          <td> const</td>
363        </tr>
364      </table>
365</div><div class="memdoc">
366
367<p>Get TabWidget. </p>
368<dl class="section return"><dt>Returns</dt><dd>TabWidget </dd></dl>
369
370</div>
371</div>
372<a class="anchor" id="ac0b1886b695379518bfeff9142d32405"></a>
373<div class="memitem">
374<div class="memproto">
375      <table class="memname">
376        <tr>
377          <td class="memname">void flair::core::FrameworkManager::SetupLogger </td>
378          <td>(</td>
379          <td class="paramtype">std::string&#160;</td>
380          <td class="paramname"><em>log_path</em></td><td>)</td>
381          <td></td>
382        </tr>
383      </table>
384</div><div class="memdoc">
385
386<p>Logger setup. </p>
387<p>Setup path of log files. <br />
388No logging will be performed if this method is not called. <br />
389 </p><dl class="params"><dt>Parameters</dt><dd>
390  <table class="params">
391    <tr><td class="paramname">log_path</td><td>path to store logs </td></tr>
392  </table>
393  </dd>
394</dl>
395
396</div>
397</div>
398<a class="anchor" id="a9f2750ce913b492206761340c666bbb6"></a>
399<div class="memitem">
400<div class="memproto">
401      <table class="memname">
402        <tr>
403          <td class="memname">void flair::core::FrameworkManager::AddDeviceToLog </td>
404          <td>(</td>
405          <td class="paramtype"><a class="el" href="classflair_1_1core_1_1_i_o_device.html">IODevice</a> *&#160;</td>
406          <td class="paramname"><em>device</em></td><td>)</td>
407          <td></td>
408        </tr>
409      </table>
410</div><div class="memdoc">
411
412<p>Add log element. </p>
413<p>The added element will be automatically logged once logging started (see <a class="el" href="classflair_1_1core_1_1_framework_manager.html#a1cbc5e8296c0f36551210e13251516ae" title="Start logging. ">StartLog()</a>). <br />
414This element must define on its side the <a class="el" href="classflair_1_1core_1_1io__data.html" title="Abstract class for data types. ">io_data</a> to log, trough IODevice::SetDataToLog method.</p>
415<dl class="params"><dt>Parameters</dt><dd>
416  <table class="params">
417    <tr><td class="paramname">device</td><td><a class="el" href="classflair_1_1core_1_1_i_o_device.html" title="Abstract class for input/ouput system. ">IODevice</a> to add </td></tr>
418  </table>
419  </dd>
420</dl>
421
422</div>
423</div>
424<a class="anchor" id="a1cbc5e8296c0f36551210e13251516ae"></a>
425<div class="memitem">
426<div class="memproto">
427      <table class="memname">
428        <tr>
429          <td class="memname">void flair::core::FrameworkManager::StartLog </td>
430          <td>(</td>
431          <td class="paramtype">void&#160;</td>
432          <td class="paramname"></td><td>)</td>
433          <td></td>
434        </tr>
435      </table>
436</div><div class="memdoc">
437
438<p>Start logging. </p>
439<p>All <a class="el" href="classflair_1_1core_1_1_i_o_device.html" title="Abstract class for input/ouput system. ">IODevice</a> added through <a class="el" href="classflair_1_1core_1_1_framework_manager.html#a9f2750ce913b492206761340c666bbb6" title="Add log element. ">AddDeviceToLog()</a> method will automatically be logged. <br />
440<a class="el" href="classflair_1_1core_1_1_framework_manager.html#ac0b1886b695379518bfeff9142d32405" title="Logger setup. ">SetupLogger()</a> must have been called before. </p>
441
442</div>
443</div>
444<a class="anchor" id="a978aae4beac0c20dbbff73369ab6e31a"></a>
445<div class="memitem">
446<div class="memproto">
447      <table class="memname">
448        <tr>
449          <td class="memname">void flair::core::FrameworkManager::StopLog </td>
450          <td>(</td>
451          <td class="paramtype">void&#160;</td>
452          <td class="paramname"></td><td>)</td>
453          <td></td>
454        </tr>
455      </table>
456</div><div class="memdoc">
457
458<p>Stop logging. </p>
459<p>Logs will automatically be sent to ground station. </p>
460
461</div>
462</div>
463<a class="anchor" id="a65eff6c3651dafddc2dd55c3cab281b4"></a>
464<div class="memitem">
465<div class="memproto">
466      <table class="memname">
467        <tr>
468          <td class="memname">bool flair::core::FrameworkManager::IsLogging </td>
469          <td>(</td>
470          <td class="paramtype">void&#160;</td>
471          <td class="paramname"></td><td>)</td>
472          <td> const</td>
473        </tr>
474      </table>
475</div><div class="memdoc">
476
477<p>Is logging? </p>
478<dl class="section return"><dt>Returns</dt><dd>true if is logging </dd></dl>
479
480</div>
481</div>
482<a class="anchor" id="a6ed9bdb73288176aa58269f8a520d58c"></a>
483<div class="memitem">
484<div class="memproto">
485      <table class="memname">
486        <tr>
487          <td class="memname">void flair::core::FrameworkManager::UpdateSendData </td>
488          <td>(</td>
489          <td class="paramtype">const <a class="el" href="classflair_1_1gui_1_1_send_data.html">gui::SendData</a> *&#160;</td>
490          <td class="paramname"><em>obj</em></td><td>)</td>
491          <td></td>
492        </tr>
493      </table>
494</div><div class="memdoc">
495
496<p>Notify that SendData's period has changed. </p>
497<p>This funtion must be called when the period has changed. <br />
498Normally, it occurs in the Widget::XmlEvent method. <br />
499This method must be called with communication blocked (see <a class="el" href="classflair_1_1core_1_1_framework_manager.html#aa1b6474b3972665d20c706ff89965271" title="Block communication. ">BlockCom()</a>).</p>
500<dl class="params"><dt>Parameters</dt><dd>
501  <table class="params">
502    <tr><td class="paramname">obj</td><td>SendData which changed </td></tr>
503  </table>
504  </dd>
505</dl>
506
507</div>
508</div>
509<a class="anchor" id="aa1b6474b3972665d20c706ff89965271"></a>
510<div class="memitem">
511<div class="memproto">
512      <table class="memname">
513        <tr>
514          <td class="memname">void flair::core::FrameworkManager::BlockCom </td>
515          <td>(</td>
516          <td class="paramtype">void&#160;</td>
517          <td class="paramname"></td><td>)</td>
518          <td></td>
519        </tr>
520      </table>
521</div><div class="memdoc">
522
523<p>Block communication. </p>
524<p>This funtion blocks the communication beetween the program and ground station. <br />
525 It must be called before changing datas or parameters exchanged between the program and the ground station. </p>
526
527</div>
528</div>
529<a class="anchor" id="a311fa9be9c08b037cae24061e85307d1"></a>
530<div class="memitem">
531<div class="memproto">
532      <table class="memname">
533        <tr>
534          <td class="memname">void flair::core::FrameworkManager::UnBlockCom </td>
535          <td>(</td>
536          <td class="paramtype">void&#160;</td>
537          <td class="paramname"></td><td>)</td>
538          <td></td>
539        </tr>
540      </table>
541</div><div class="memdoc">
542
543<p>Unblock communication. </p>
544<p>This funtion unblocks the communication beetween the program and ground station. <br />
545 It must be called after changing datas or parameters exchanged between the program and the ground station. </p>
546
547</div>
548</div>
549<a class="anchor" id="a845ac3ad0cbc95d71e50277d9e8093a1"></a>
550<div class="memitem">
551<div class="memproto">
552      <table class="memname">
553        <tr>
554          <td class="memname">bool flair::core::FrameworkManager::ConnectionLost </td>
555          <td>(</td>
556          <td class="paramtype">void&#160;</td>
557          <td class="paramname"></td><td>)</td>
558          <td> const</td>
559        </tr>
560      </table>
561</div><div class="memdoc">
562
563<p>Is connection lost? </p>
564<p>Once this method returns true, it will never return false back. <br />
565 Note that this method return false if no connection is defined (see SetupConnection).</p>
566<dl class="section return"><dt>Returns</dt><dd>true if connection with ground station is lost </dd></dl>
567
568</div>
569</div>
570<a class="anchor" id="a69e12f51081a3d58876553d9858ea1bd"></a>
571<div class="memitem">
572<div class="memproto">
573      <table class="memname">
574        <tr>
575          <td class="memname">void flair::core::FrameworkManager::DisableErrorsDisplay </td>
576          <td>(</td>
577          <td class="paramtype">bool&#160;</td>
578          <td class="paramname"><em>value</em></td><td>)</td>
579          <td></td>
580        </tr>
581      </table>
582</div><div class="memdoc">
583
584<p>Disable errors display. </p>
585<p>Disable errors display, if you do not want to saturate console for exemple. By defaults errors disply is enabled.</p>
586<dl class="params"><dt>Parameters</dt><dd>
587  <table class="params">
588    <tr><td class="paramname">value</td><td>true to disable errors display </td></tr>
589  </table>
590  </dd>
591</dl>
592
593</div>
594</div>
595<a class="anchor" id="a477b3cee8fa2c2338896006faaeefe42"></a>
596<div class="memitem">
597<div class="memproto">
598      <table class="memname">
599        <tr>
600          <td class="memname">bool flair::core::FrameworkManager::IsDisplayingErrors </td>
601          <td>(</td>
602          <td class="paramtype">void&#160;</td>
603          <td class="paramname"></td><td>)</td>
604          <td> const</td>
605        </tr>
606      </table>
607</div><div class="memdoc">
608
609<p>Is displaying errors? </p>
610<dl class="section return"><dt>Returns</dt><dd>true if errors display is enabled </dd></dl>
611
612</div>
613</div>
614</div><!-- contents -->
615</div><!-- doc-content -->
616<!-- start footer part -->
617<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
618  <ul>
619    <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_1_framework_manager.html">FrameworkManager</a></li>
620    <li class="footer">Generated on Mon Jul 18 2016 06:45:46 for Flair by
621    <a href="http://www.doxygen.org/index.html">
622    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
623  </ul>
624</div>
625</body>
626</html>
Note: See TracBrowser for help on using the repository browser.