Changeset 33 in flair-dev for trunk/doc/Flair/classflair_1_1core_1_1_framework_manager.html

Timestamp:

08/29/16 17:35:55 (8 years ago)

Author:

Sanahuja Guillaume

Message:

m

File:

• trunk/doc/Flair/classflair_1_1core_1_1_framework_manager.html (modified) (6 diffs)

trunk/doc/Flair/classflair_1_1core_1_1_framework_manager.html

@@ -141 +141 @@
 <tr class="memdesc:aa97c7fbaba572aa856d23c416f3b74e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#aa97c7fbaba572aa856d23c416f3b74e4">More...</a><br /></td></tr>
 <tr class="separator:aa97c7fbaba572aa856d23c416f3b74e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<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>
-<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>
-<tr class="separator:ab2a2ea16b7d5558ac24c24476eb5116f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a536f78b53e6f4890120b1312aa3c7b88"><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#a536f78b53e6f4890120b1312aa3c7b88">SetupConnection</a> (std::string address, uint16_t port, <a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> watchdogTimeout=(<a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a>) 1000000000, size_t rcv_buf_size=10000)</td></tr>
+<tr class="memdesc:a536f78b53e6f4890120b1312aa3c7b88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setup the connection with ground station.  <a href="#a536f78b53e6f4890120b1312aa3c7b88">More...</a><br /></td></tr>
+<tr class="separator:a536f78b53e6f4890120b1312aa3c7b88"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <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>
 <tr class="memdesc:a528ab69c3a850237007a074732d9fa85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setup the user interface.  <a href="#a528ab69c3a850237007a074732d9fa85">More...</a><br /></td></tr>
@@ -283 +283 @@
 </div>
 <h2 class="groupheader">Member Function Documentation</h2>
-<a class="anchor" id="ab2a2ea16b7d5558ac24c24476eb5116f"></a>
+<a class="anchor" id="a536f78b53e6f4890120b1312aa3c7b88"></a>
 <div class="memitem">
 <div class="memproto">
@@ -302 +302 @@
           <td class="paramkey"></td>
           <td></td>
+          <td class="paramtype"><a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a>&#160;</td>
+          <td class="paramname"><em>watchdogTimeout</em> = <code>(<a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a>)&#160;1000000000</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
           <td class="paramtype">size_t&#160;</td>
           <td class="paramname"><em>rcv_buf_size</em> = <code>10000</code>&#160;</td>
@@ -314 +320 @@
 
 <p>Setup the connection with ground station. </p>
-<p>Call this method just after the constructor of this class. If this method is not called, the program will run headless.</p>
+<p>Call this method just after the constructor of this class. If this method is not called, the program will run headless. If this method is called, SetupUserInterface must also be called after this.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">address</td><td>address of ground station </td></tr>
     <tr><td class="paramname">port</td><td>port of ground station </td></tr>
+    <tr><td class="paramname">watchdogTimeout</td><td>watchdog timeout for the connection, passing TIME_INFINITE will disable the watchdog </td></tr>
     <tr><td class="paramname">rcv_buf_size</td><td>receive buffer size </td></tr>
   </table>
@@ -341 +348 @@
 
 <p>Setup the user interface. </p>
-<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>
+<p>If this method is called after SetupConnection, Widgets will be displayed in the ground station. If this method is called and SetupConnection was not called, it will run headless but default values of Widgets will be taken from the xml file. If this method is not called, Widgets will not be available. Constructing an object based on Widget class will fail.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
@@ -618 +625 @@
   <ul>
     <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>
-    <li class="footer">Generated on Wed Jul 27 2016 06:38:45 for Flair by
+    <li class="footer">Generated on Mon Aug 29 2016 15:26:01 for Flair by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>