eCAL v5.5.4:

* common: * repository maintenance (CamelCase to snake_case) * command line interface documentation fixed * language bindings * csharp support added * apps * ecal launcher utility added * ecal player shows status in windows taskbar icon Co-authored-by: Rex Schilasky <[email protected]> Co-authored-by: Kerstin Keller <[email protected]> Co-authored-by: Florian Reimold <[email protected]>
eclipse-ecal · Mar 3, 2020 · 6990f28 · 6990f28
1 parent ceeef2a
commit 6990f28
Show file tree

Hide file tree

Showing 391 changed files with 13,183 additions and 6,312 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -44,6 +44,7 @@ option(BUILD_APPS                              "Build the eCAL applications"
 option(BUILD_SAMPLES                           "Build the eCAL samples"                                            ON)
 option(BUILD_TIME                              "Build the eCAL time interfaces"                                    ON)
 option(BUILD_PY_BINDING                        "Build eCAL python binding"                                        OFF)
+option(BUILD_CSHARP_BINDING                    "Build eCAL C# binding"                                            OFF)
 option(BUILD_TESTS                             "Build the eCAL google tests"                                      OFF)
 
 option(ECAL_LAYER_ICEORYX                      "Use iceoryx shared memory as local communication layer"           OFF)
@@ -341,7 +342,7 @@ endif(HAS_QT5)
 # --------------------------------------------------------
 # ecal mon plugin sdk
 # --------------------------------------------------------
-add_subdirectory(app/mon/eCALMonPluginLib)
+add_subdirectory(app/mon/mon_plugin_lib)
 
 # --------------------------------------------------------
 # ecal time
@@ -368,22 +369,30 @@ if(BUILD_PY_BINDING)
   add_subdirectory(lang/python)
 endif()
 
+# --------------------------------------------------------
+# ecal core csharp binding
+# --------------------------------------------------------
+if(BUILD_CSHARP_BINDING AND WIN32)
+  add_subdirectory(lang/csharp/Continental/eCAL/Core/)
+  #add_subdirectory(lang/csharp/Continental/eCAL/Protobuf/)
+endif()
+
 # --------------------------------------------------------
 # console applications
 # --------------------------------------------------------
 add_subdirectory(app/apps)
 if(BUILD_APPS)
-  add_subdirectory(app/mon/eCALTopic/src)
-  add_subdirectory(app/util/eCALConfig/src)
-  add_subdirectory(app/util/eCALStop/src)
+  add_subdirectory(app/mon/topic)
+  add_subdirectory(app/util/config)
+  add_subdirectory(app/util/stop)
 endif()
 
 # --------------------------------------------------------
 # applications using hdf5
 # --------------------------------------------------------
 if(BUILD_APPS AND HAS_HDF5)
-  add_subdirectory(app/play/eCALPlayCore)
-  add_subdirectory(app/play/eCALPlay)
+  add_subdirectory(app/play/play_core)
+  add_subdirectory(app/play/play_cli)
 
   add_subdirectory(app/rec/rec_cli)
   add_subdirectory(app/rec/rec_core)
@@ -394,18 +403,19 @@ endif()
 # qt applications
 # --------------------------------------------------------
 if(BUILD_APPS AND HAS_QT5)
-  add_subdirectory(app/mon/eCALMon)
+  add_subdirectory(app/mon/mon_gui)
+  add_subdirectory(app/util/launcher)
   if(WIN32)
     set(ECAL_MON_PLUGIN_DIR ecalmon_plugins)
   else()
     set(ECAL_MON_PLUGIN_DIR ecal/plugins/mon)
   endif()
-  add_subdirectory(app/mon/eCALMonPlugins)
+  add_subdirectory(app/mon/mon_plugins)
 # --------------------------------------------------------
 # qt applications using hdf5
 # --------------------------------------------------------
 if(BUILD_APPS AND HAS_QT5 AND HAS_HDF5)
-  add_subdirectory(app/play/eCALPlayGUI)
+  add_subdirectory(app/play/play_gui)
   add_subdirectory(app/rec/rec_gui)
 endif()
 endif()

diff --git a/README.md b/README.md
@@ -67,6 +67,8 @@ eCAL is using CMake as build system. When configuring with CMake, you can turn o
   Build the eCAL time interfaces, necessary if you want to use ecal in time synchronized mode (based on ptp for example)
 - `BUILD_PY_BINDING`, default `OFF`
   Build the eCAL python language binding
+- `BUILD_CSHARP_BINDING`, default `OFF`
+  Build the eCAL C# language binding
 - `BUILD_TESTS', default `OFF`
   Build the eCAL google tests
 - `ECAL_LAYER_ICEORYX`, default `OFF`
@@ -1112,6 +1114,116 @@ while ecal_core.ok():
 ecal_core.finalize()
 ```
 
+### CSharp
+
+TODO: Describe this ..
+
+#### The Publish-Subscribe Pattern
+
+##### Listing 20
+
+```csharp
+using System;
+using Continental.eCAL.Core;
+
+public class minimal_snd
+{
+  static void Main()
+  {
+    // initialize eCAL API
+    Util.Initialize("minimal_snd");
+
+    // create a publisher (topic name "Hello", type "base:std::string", description "")
+    Publisher publisher = new Publisher("Hello", "base:std::string", "");
+
+    // idle main thread
+    int loop = 0;
+    while (Util.Ok())
+    {
+      // message to send
+      string message = String.Format("HELLO WORLD FROM C# {0,6}", ++loop);
+
+      // send the content
+      publisher.Send(message, -1);
+
+      // cool down
+      System.Threading.Thread.Sleep(100);
+    }
+
+    // finalize eCAL API
+    Util.Terminate();
+  }
+}
+```
+
+##### Listing 21
+
+```csharp
+using System;
+using Continental.eCAL.Core;
+
+public class minimal_rcv
+{
+  static void Main()
+  {
+    // initialize eCAL API
+    Util.Initialize("minimal_rcv");
+
+    // create a subscriber (topic name "Hello", type "base:std::string")
+    Subscriber subscriber = new Subscriber("Hello", "base:std::string", "");
+
+    // idle main thread
+    while (Util.Ok())
+    {
+      // receive content with 100 ms timeout
+      Subscriber.ReceiveCallbackData message = subscriber.Receive(100);
+
+      // print message
+      if (message != null) System.Console.WriteLine(String.Format("Received:  {0}", message.data));
+    }
+
+    // finalize eCAL API
+    Util.Terminate();
+  }
+}
+```
+
+##### Listing 22
+
+```csharp
+using System;
+using Continental.eCAL.Core;
+
+public class minimal_rcv_cb
+{
+  static void MyCallback(String topic, Subscriber.ReceiveCallbackData data)
+  {
+    System.Console.WriteLine("Topic name " + topic);
+    System.Console.WriteLine("Topic content " + data.data);
+  }
+
+  static void Main()
+  {
+    // initialize eCAL API
+    Util.Initialize("minimal_rcv_cb");
+
+    // create a subscriber (topic name "Hello", type "base:std::string")
+    Subscriber subscriber = new Subscriber("Hello", "base:std::string", "");
+    Subscriber.ReceiverCallback callback = MyCallback;
+    subscriber.AddReceiveCallback(callback);
+
+    // idle main thread
+    while (Util.Ok())
+    {
+      System.Threading.Thread.Sleep(100);
+    }
+
+    // finalize eCAL API
+    Util.Terminate();
+  }
+}
+```
+
 ## Command Line Interface
 
 If you pass the argc, argv command line arguments to the eCAL::Initialize API function (see Listing 23) you can set / overwrite all eCAL runtime parameter defined in the eCAL parameter ini file (ecal.ini). Moreover you can force your application to not load the default eCAL ini file but to specify your own parameter file for the system wide default settings.
@@ -1140,10 +1252,10 @@ Sometimes you want to handle your own arguments but still forward eCAL specific
 ```cpp
 std::vector<std::string> args;
 
-args.push_back("--default-ini-file");
+args.push_back("--ecal-ini-file");
 args.push_back("/home/share/ecal.ini");
 
-args.push_back("--set_config_key");
+args.push_back("--ecal-set-config-key");
 args.push_back("network/network_enabled:true");
 
 eCAL::Initialize(args, "unit name");
@@ -1157,70 +1269,71 @@ foo.exe --help
 
 The output will look like this
 
-  USAGE: 
-
-     foo.exe  [-s <string>] ...  [-n <string>] [-d <string>] [-c] [--]
-                     [--version] [-h]
-
-
-  Where: 
-
-     -s <string>,  --set_config_key <string>  (accepted multiple times)
-       Overwrite a specific configuration key (set_config_key
+  USAGE:
+
+     ecal_sample_person_snd.exe  [--ecal-set-config-key <string>] ...
+                              [--ecal-ini-file <string>] [--ecal-dump-config]
+                              [--] [--version] [-h]
+
+
+  Where:
+
+     --ecal-set-config-key <string>  (accepted multiple times)
+       Overwrite a specific configuration key (ecal-set-config-key
        "section/key:value".
-  
-     -d <string>,  --default-ini-file <string>
+
+     --ecal-ini-file <string>
        Load default configuration from that file.
-  
-     -c,  --dump-config
+
+     --ecal-dump-config
        Dump current configuration.
-  
+
      --,  --ignore_rest
        Ignores the rest of the labeled arguments following this flag.
-  
+
      --version
        Displays version information and exits.
-  
+
      -h,  --help
        Displays usage information and exits.
-
 
-### The --default-ini-file (-d) option
+
+### The --ecal-ini-file option
 
 Load default configuration from that file.
 
 Usage:
 
 ```bat
-foo.exe --default-ini-file "/home/share/my_ecal.ini"
+foo.exe --ecal-ini-file "/home/share/my_ecal.ini"
 ```
 
 Will load `/home/share/my_ecal.ini` file instead the eCAL default ini file (located in the `%APPDATA%` folder under windows or in `~/.ecal` under Linux)
 
-### The --set_config_key (-s) option
+### The --ecal-set-config-key option
 
 Overwrite a specific configuration key. This option can be used multiple times.
 
 Usage:
 
 ```bat
-foo.exe --set_config_key "network/network_enabled:true" --set_config_key "network/multicast_ttl:3"
+foo.exe --ecal-set-config-key "network/network_enabled:true" --ecal-set-config-key "network/multicast_ttl:3"
 ```
 
 Will overwrite the 2 network settings network_enabled and multicast_ttl (defined in ecal.ini file) with the values "true" and "3".
 
-### The --dump-config (-d) option
+### The --ecal-dump-config option
 
 Usage:
 
 ```bat
-foo.exe --dump-config
+foo.exe --ecal-dump-config
 ```
 
 Will dump the whole currently used configuration. This option is very useful in combination with the options mentioned above. For example
 
 ```bat
-foo.exe --dump-config --default-ini-file "/home/share/my_ecal.ini"
+foo.exe --ecal-dump-config --ecal-ini-file "/home/share/my_ecal.ini"
 ```
 
 Will load the specified default eCAL ini file and print out the loaded configuration.

diff --git a/app/apps/include/ecal/ecal_apps.h b/app/apps/include/ecal/ecal_apps.h
@@ -23,6 +23,9 @@ namespace eCAL
 {
   namespace Apps
   {
-    constexpr char MON[] = "ecal_mon";
+    constexpr char MON[]      = "ecal_mon";
+    constexpr char REC[]      = "ecal_rec";
+    constexpr char PLAY_GUI[] = "ecal_play_gui";
+    constexpr char REC_GUI[]  = "ecal_rec_gui";
   }
 }
diff --git a/app/iconset/FlorianReimold/Exit.svg b/app/iconset/FlorianReimold/Exit.svg