[TOC]
iShapes is an interactive GUI based DDS (Data Distribution Service) Application to learn, demonstate and test dds key concepts.
It shows and demonstrates the key dds concepts and some of the key DDS Quality of Services (QoSs). It has also been used at the OMG ( Object Management Group) to test the interoperability of the ADLINK DDS products with other compliant DDS implementations.
Each geometrical shape is represented by a dedicated dds topic such as a Circle, Triangle, etc ....
All the geometrical shapes share the same dataType. The dataType structure is modeled in an .idl file.
The shape dataType is characterized by its color, its position in a 2D space and its Size. Shapes with different colors are considered different data objects, i,e different data instances, as the color data attribute is considered the @Key of the dataType. Each data instance has its unique identity, its own lifecycle and its state.
The iShapes demo application code is common for ADLINK Vortex Opensplice and Cyclone DDS.
ishapes can be rely on Cyclone DDS only, or Vortex Opensplice dds only, or you can run some ishapes instances with Cyclone and others with Opensplice typically if you want to test interoperability between the too products.
For the Cyclone Ishape demo, the Cyclone DDS C core, CXX Idl compiler and the C++ binding for Cyclone DDS need to be installed before proceeding.
You can get Cyclone C Core from https://github.com/eclipse-cyclonedds/cyclonedds.git and the related C++ APIs from https://github.com/eclipse-cyclonedds/cyclonedds-cxx
For Vortex Opensplice Ishape demo Vortex Opensplice DDS need to be installed before proceeding. you can download the Vortex Opensplice DDS from ADLINK Website : https://www.adlinktech.com/en/vortex-opensplice-data-distribution-service
To clone the ishape demo application in your locale repository, do
$ git clone https://github.com/atolab/dds-ishapes
$ cd Adlink_DDS_Demo_Ishapes From now one, we assume Cylone DDS or Vortex Opensplice and QT5 are installed
To build the iShapes demo you need to have installed a QT5 development environment. The following QT5 environment variables has to be set in order to build and run ishapes:
$ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<qt5_install-location>
Where <qt5_install-location> is the installation directory of your QT5 installation , e.g (/usr/lib/x86_64_linux-gnu/qt5) If Cyclone DDS is not installed on the linux default locations ( i.e /usr/lib , /usr/bin ...) you need to update further the LD_LIBRARY_PATH and the PATH env variables. This is described below:
1) The LD_LIBRARY_PATH needs to be updated also to point to Cyclone DDS liberaries
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<cxx_install-location>/lib
2) Update also the PATH env variable to your Cyclone DDS bin directory
export PATH=<cxx_install-location> /bin:$PATH
Where <cxx_install-location> is the location of Cyclone DDS C++ package (e.g /home/<UserName>/CycloneDDS1.0.0-Linux/) To start the real build process go to your iShape-demo root directory and follow those steps:
$ mkdir cyclone_demo_ishapes && cd cyclone_demo_ishapes
$ cmake .. -DADLINK_DDS_PRODUCT=Cyclone -DCYCLONE_INSTALLED_DIR="<cxx_install-location>"
$ cmake --build . --config Release --target install
<cxx_install-location> is, again, the location of Cyclone DDS C++ package
Note: please use '--config Debug' if you are using Cyclone DDS debug build to build this iShape application.To build the demo you need to have installed a QT5 development environment. The following QT5 environment variables has to be set in order to build and run ishapes:
C:\> set QTDIR=<QT5-INSTALLATION-DIR>
C:\> set QT_PLUGIN_PATH=<QT5-INSTALLATION-DIR>\plugins
C:\> set PATH=<QT5-INSTALLATION-DIR>\bin;%PATH%
Where <QT5-INSTALLATION-DIR> is the installation directory of your QT5 installation , e.g (<C:\Qt\5.7.1> ) then you need to simply do the following from the iShape demo root directory:
$ mkdir cyclone_demo_ishapes && cd cyclone_demo_ishapes
$ cmake .. -DADLINK_DDS_PRODUCT=Cyclone -DCYCLONE_INSTALLED_DIR="<cxx_install-location>" -G "<generator-name>"
$ cmake --build . --config Release --target install Where <cxx_install-location> is the location of the Cyclone DDS C++ package and <generator-name> by one of the ways CMake generators
offer for generating build files. For example, "Visual Studio 15 2017 Win64" would target a 64-bit build using Visual Studio 2017.
Note: please use '--config Debug' if you are using Cyclone DDS debug build to build this iShape application.
To build the iShapes demo you need to have installed a QT5 development environment. The following QT5 environment variables has to be set in order to build and run ishapes:
$ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<qt5_install-location>
Where <qt5_install-location> is the installation directory of your QT5 installation , e.g (/usr/lib/x86_64_linux-gnu/qt5) then you need to simply do the following from the iShape demo root directory:
$ source <ospl_install-location>/release.com
$ mkdir ospl_demo_ishapes && cd ospl_demo_ishapes
$ cmake .. -DADLINK_DDS_PRODUCT=Ospl
$ cmake --build . --config Release --target install
Where <ospl_install-location> is the location of Opensplice DDS Home directory.e. The corresponding Opensplice environment variable is OSPL_HOME.
The <ospl_install-location>/release.com batch file will update the LD_LIBRARY_PATH and PATH env variables with the appropriate Opensplice libs and commands.
Note: please use '--config Debug' if you are using Opensplice DDS debug build to build this iShape application.To build the demo you need to have installed a QT5 development environment. The following QT5 environment variables has to be set in order to build and run ishapes:
C:\> set QTDIR=<QT5-INSTALLATION-DIR>
C:\> set QT_PLUGIN_PATH=<QT5-INSTALLATION-DIR>\plugins
C:\> set PATH=<QT5-INSTALLATION-DIR>\bin;%PATH%
C:\> "<ospl_install-location>"\release.bat
Where is the installation directory of your QT5 installation , e.g (<C:\Qt\5.7.1> ) then you need to simply do the following from the iShape demo root directory:
$ "<ospl_install-location>"\release.bat
$ mkdir ospl_demo_ishapes && cd ospl_demo_ishapes
$ cmake .. -DADLINK_DDS_PRODUCT=Ospl -G "<generator-name>"
$ cmake --build . --config Release --target install Where <ospl_install-location> is the location of Opensplice DDS Home directory and <generator-name> by one of the ways CMake generators offer for generating build files. For example, "Visual Studio 15 2017 Win64" would target a 64-bit build using Visual Studio 2017.
Note: please use '--config Debug' if you are using Opensplice DDS debug build to build this iShape application.
The iShapes demo allows you to publish and subscribe instances of various shapes. The demo is didactic if you run it as at least into two application instances, thus from a shell do one of the below then have one of the applications publish some shapes and press the subscribe button on the other application to receive them.
image-20201022104103958
cyclone_demo_ishapes is intalled in the
$ <cxx_install-location>/bin/cyclone_demo_ishapes &
$ <cxx_install-location>/bin/cyclone_demo_ishapes & Where
Note: You can pass DDS domain id and partition(s) as command line arguments to start cyclone_demo_ishapes in a particular DDS domain and start publication and subscription in particular partition(s). for example to start cyclone_demo_ishapes application in domain 1 and publish and subscribe topic(s) in "Partition-1" and "Partition-2"
$ <cxx_install-location>/bin/cyclone_demo_ishapes 1 Partition-1 Partition-2 &
$ <cxx_install-location>/bin/cyclone_demo_ishapes 1 Partition-1 Partition-2 &cyclone_demo_ishapes is intalled in
C:\> start <cxx_install-location>\bin\cyclone_demo_ishapes
C:\> start <cxx_install-location>\bin\cyclone_demo_ishapes Where
Note: You can pass DDS domain id and partition(s) as command line arguments to start cyclone_demo_ishapes in a particular DDS domain and start publication and subscription in particular partition(s). for example to start cyclone_demo_ishapes application in domain 1 and publish and subscribe topic(s) in "Partition-1" and "Partition-2"
C:\> start <cxx_install-location>\bin\cyclone_demo_ishapes 1 Partition-1 Partition-2
C:\> start <cxx_install-location>\bin\cyclone_demo_ishapes 1 Partition-1 Partition-2ospl_demo_ishapes is available in
$ source <ospl_install-location>/release.com
$ <ospl_install-location>/bin/ospl_demo_ishapes &
$ <ospl_install-location>/bin/ospl_demo_ishapes &
Where <ospl_install-location> is the location of Opensplice DDS Home directory.
Note: You can pass DDS domain id and partition(s) as command line arguments to start ospl_demo_ishapes in a particular DDS domain and start publication and subscription in particular partition(s). for example to start ospl_demo_ishapes application in domain 1 and publish and subscribe topic(s) in "Partition-1" and "Partition-2"
$ <ospl_install-location>/bin/ospl_demo_ishapes 1 Partition-1 Partition-2 &
$ <ospl_install-location>/bin/ospl_demo_ishapes 1 Partition-1 Partition-2 & $ "<ospl_install-location>"\release.bat
C:\> start <ospl_install-location>\bin\ospl_demo_ishapes
C:\> start <ospl_install-location>\bin\ospl_demo_ishapes
Where <ospl_install-location> is the location of Opensplice DDS Home directory.
Note: You can pass DDS domain id and partition(s) as command line arguments to start ospl_demo_ishapes in a particular DDS domain and start publication and subscription in particular partition(s). for example to start ospl_demo_ishapes application in domain 1 and publish and subscribe topic(s) in "Partition-1" and "Partition-2"
C:\> start <ospl_install-location>\bin\ospl_demo_ishapes 1 Partition-1 Partition-2
C:\> start <ospl_install-location>\bin\ospl_demo_ishapes 1 Partition-1 Partition-2