Changeset 29 in flair-dev for trunk/include/FlairCore

Timestamp:

Jul 29, 2016, 3:19:13 PM (8 years ago)

Author:

Sanahuja Guillaume

Message:

m

File:

• trunk/include/FlairCore/FrameworkManager.h (modified) (3 diffs)

trunk/include/FlairCore/FrameworkManager.h

@@ -19 +19 @@
 
 namespace flair {
-namespace gui {
-class TabWidget;
-class SendData;
-}
+  namespace gui {
+    class TabWidget;
+    class SendData;
+  }
 }
 namespace flair {
@@ -69 +69 @@
   *
   * Call this method just after the constructor of this class. If this method is
-  *not called, the program will run headless.
+  * not called, the program will run headless.
+  * If this method is called, SetupUserInterface must also be called after this.
   *
   * \param address address of ground station
   * \param port port of ground station
+  * \param watchdogTimeout watchdog timeout for the connection, passing TIME_INFINITE will disable the watchdog
   * \param rcv_buf_size receive buffer size
   */
-  void SetupConnection(std::string address, uint16_t port,
+  void SetupConnection(std::string address, uint16_t port,Time watchdogTimeout=(Time)1000000000,
                        size_t rcv_buf_size = 10000);
 
@@ -82 +84 @@
   *
   * 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.
+  * 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.
   *
   * \param xml_file xml file for default values of Widgets