Update Fast DDS-Gen documentation [8708] (#165)

* Refs #8644: Restructured and updated according to the installation section. * Refs #8644: Updated introduction. Signed-off-by: RaulSanchez <raul@eprosima.com> * Refs #8644: Updated simple pub/sub application. Signed-off-by: RaulSanchez <raul@eprosima.com> * Refs #8644: Added IDL data types section. Signed-off-by: RaulSanchez <raul@eprosima.com> * Refs #8644: Added usage section. Signed-off-by: RaulSanchez <raul@eprosima.com> * Refs #8644: Added Fast DDS-Gen CodeTester. Signed-off-by: RaulSanchez <raul@eprosima.com> * Refs #8644: Updated directories, rst files and hyperlinks to fastddsgen. Signed-off-by: RaulSanchez <raul@eprosima.com> * Refs #8644: Changed Fast DDS-Gen to italics. Signed-off-by: RaulSanchez <raul@eprosima.com> * Refs #8644: Applied suggested changes. Signed-off-by: RaulSanchez <raul@eprosima.com> * Refs #8644: Added IDL comments subsection. Signed-off-by: RaulSanchez <raul@eprosima.com> * Refs #8644: Fixed minor typos. Signed-off-by: RaulSanchez <raul@eprosima.com> * Refs #8644: Added windows dependencies and applied suggested changes. Signed-off-by: RaulSanchez <raul@eprosima.com> * Refs #8644: Added a reference to the fastddsgen tutorial in getting started. Signed-off-by: RaulSanchez <raul@eprosima.com> Co-authored-by: RaulSanchez <raul@eprosima.com>
eProsima · Jun 18, 2020 · e43063b · e43063b
1 parent 3fac664
commit e43063b
Show file tree

Hide file tree

Showing 27 changed files with 801 additions and 497 deletions.
diff --git a/code/CMakeLists.txt b/code/CMakeLists.txt
@@ -192,7 +192,7 @@ if(BUILDCOP)
     ####################################################################################################################
     # Compile example
     ####################################################################################################################
-    add_executable(doctest CodeTester.cpp DDSCodeTester.cpp)
+    add_executable(doctest CodeTester.cpp DDSCodeTester.cpp FastDDSGenCodeTester.cpp)
     target_include_directories(doctest PRIVATE ${PROJECT_BINARY_DIR}/external/eprosima/src/fastdds/src/cpp
         ${PROJECT_BINARY_DIR}/external/eprosima/src/fastdds/thirdparty/tinyxml2)
     target_link_libraries(doctest fastrtps)

diff --git a/code/FastDDSGenCodeTester.cpp b/code/FastDDSGenCodeTester.cpp
@@ -0,0 +1,140 @@
+#include <stdint.h>
+#include <string>
+#include <bitset>
+
+using octet = unsigned char;
+
+// STRUCTURES_DATA_TYPE
+class Structure
+{
+public:
+    Structure();
+    ~Structure();
+    Structure(const Structure &x);
+    Structure(Structure &&x);
+    Structure& operator=(const Structure &x);
+    Structure& operator=(Structure &&x);
+
+    void octet_value(uint8_t _octet_value);
+    uint8_t octet_value() const;
+    uint8_t& octet_value();
+    void long_value(int64_t _long_value);
+    int64_t long_value() const;
+    int64_t& long_value();
+    void string_value(const std::string
+        &_string_value);
+    void string_value(std::string &&_string_value);
+    const std::string& string_value() const;
+    std::string& string_value();
+
+private:
+    uint8_t m_octet_value;
+    int64_t m_long_value;
+    std::string m_string_value;
+};
+//!
+
+// STRUCTURE_INHERITANCE
+class ParentStruct
+{
+    octet parent_member;
+};
+
+class ChildStruct : public ParentStruct
+{
+    long child_member;
+};
+//!
+
+
+// UNION_DATA_TYPE
+class Union
+{
+public:
+    Union();
+    ~Union();
+    Union(const Union &x);
+    Union(Union &&x);
+    Union& operator=(const Union &x);
+    Union& operator=(Union &&x);
+
+    void d(int32_t __d);
+    int32_t _d() const;
+    int32_t& _d();
+
+    void octet_value(uint8_t _octet_value);
+    uint8_t octet_value() const;
+    uint8_t& octet_value();
+    void long_value(int64_t _long_value);
+    int64_t long_value() const;
+    int64_t& long_value();
+    void string_value(const std::string
+        &_string_value);
+    void string_value(std:: string &&_string_value);
+    const std::string& string_value() const;
+    std::string& string_value();
+
+private:
+    int32_t m__d;
+    uint8_t m_octet_value;
+    int64_t m_long_value;
+    std::string m_string_value;
+};
+//!
+
+// BITSET_DATA_TYPE
+class MyBitset
+{
+public:
+    void a(char _a);
+    char a() const;
+
+    void b(uint16_t _b);
+    uint16_t b() const;
+
+    void c(int32_t _c);
+    int32_t c() const;
+
+private:
+    std::bitset<25> m_bitset;
+};
+//!
+
+// BITSET_INHERITANCE
+class ParentBitset
+{
+    std::bitset<3> parent_member;
+};
+
+class ChildBitset : public ParentBitset
+{
+    std::bitset<10> child_member;
+};
+//!
+
+// ENUMERATION_DATA_TYPE
+enum Enumeration : uint32_t
+{
+    RED,
+    GREEN,
+    BLUE
+};
+//!
+
+// BITMASK_DATA_TYPE
+enum MyBitMask : uint8_t
+{
+    flag0 = 0x01 << 0,
+    flag1 = 0x01 << 1,
+    flag4 = 0x01 << 4,
+    flag6 = 0x01 << 6,
+    flag7 = 0x01 << 7
+};
+//!
+
+/*
+// INCLUDE_MORE_IDL_FILES
+#include "OtherFile.idl"
+#include <AnotherFile.idl>
+//!
+/**/
diff --git a/docs/02-formalia/titlepage.rst b/docs/02-formalia/titlepage.rst
@@ -18,7 +18,7 @@ distributed network paradigm that neatly allows separation of the publisher and
 *eProsima Fast DDS* comprises:
 
 * The :ref:`DDS API <dds_layer>` implementation.
-* :ref:`Fast DDS-Gen <fastrtpsgen_intro>`, a generation tool for bridging typed interfaces with the middleware
+* :ref:`Fast DDS-Gen <fastddsgen_intro>`, a generation tool for bridging typed interfaces with the middleware
   implementation.
 * The underlying :ref:`RTPS <rtps_layer>` wire protocol implementation.
 
@@ -64,7 +64,7 @@ Fast DDS-Gen
 
 Relying on interfaces implies the need for a generation tool that translates type descriptions into appropriate
 implementations that fill the gap between the interfaces and the middleware.
-This task is carried out by a dedicated generation tool, :ref:`Fast DDS-Gen <fastrtpsgen_intro>`, a Java application
+This task is carried out by a dedicated generation tool, :ref:`Fast DDS-Gen <fastddsgen_intro>`, a Java application
 that generates source code using the data types defined in an
 `Interface Definition Language (IDL) <https://www.omg.org/spec/IDL/About-IDL/>`__ file.
 

diff --git a/docs/fastdds/dds_layer/topic/fastddsgen/fastddsgen.rst b/docs/fastdds/dds_layer/topic/fastddsgen/fastddsgen.rst
@@ -9,7 +9,7 @@ Fast DDS-Gen for data types source code generation
 translating an IDL specification of a data type to a functional implementation.
 Thus, this tool automatically generates the source code of a data type defined using IDL.
 A basic use of the tool is described below.
-To learn about all the features that Fast DDS offers, please refer to :ref:`Fast DDS-Gen <fastrtpsgen_intro>` section.
+To learn about all the features that Fast DDS offers, please refer to :ref:`Fast DDS-Gen <fastddsgen_intro>` section.
 
 Basic usage
 ^^^^^^^^^^^
@@ -31,7 +31,7 @@ The IDL file containing the data type definition is given with the ``<IDLfile>``
 |    fastrtpsgen.bat [<options>] <IDLfile> [<IDLfile> ...]                                                             |
 +----------------------------------------------------------------------------------------------------------------------+
 
-Among the available arguments defined in :ref:`fastrtpsgen_use`, the main Fast DDS-Gen options for data type source
+Among the available arguments defined in :ref:`fastddsgen_usage`, the main Fast DDS-Gen options for data type source
 code generation are the following:
 
 *   ``-replace``: It replaces existing files in case the data type files have been previously generated.
@@ -42,7 +42,7 @@ code generation are the following:
     the given ``platform``.
     Thus, Fast DDS-Gen tool can generate a sample application using the provided data type, together with a
     `Makefile`, to compile it on Linux distributions, and a Visual Studio project for Windows.
-    To see an example of this please refer to tutorial :ref:`fastrtpsgen_pubsub_app`.
+    To see an example of this please refer to tutorial :ref:`fastddsgen_pubsub_app`.
 
 Output files
 ^^^^^^^^^^^^

diff --git a/docs/fastdds/getting_started/simple_app/includes/dataType.rst b/docs/fastdds/getting_started/simple_app/includes/dataType.rst
@@ -8,8 +8,8 @@ Interface Description Language (IDL) file. This application can do two different
 2. Generate a functional example that uses your topic data.
 
 It will be the former that will be followed in this tutorial.
-To see an example of application of the latter you can check this other :ref:`example <fastrtpsgen_pubsub_app>`.
-See :ref:`fastrtpsgen_intro` for further details.
+To see an example of application of the latter you can check this other :ref:`example <fastddsgen_pubsub_app>`.
+See :ref:`fastddsgen_intro` for further details.
 For this project, we will use the Fast DDS-Gen application to define the data type of the messages that will be sent
 by the publishers and received by the subscribers.
 

diff --git a/docs/fastdds/getting_started/simple_app/simple_app.rst b/docs/fastdds/getting_started/simple_app/simple_app.rst
@@ -7,6 +7,9 @@ Writing a simple publisher and subscriber application
 
 This section details how to create an simple Fast DDS application with a publisher and a subscriber
 step by step.
+It is also possible to self-generate a similar example to the one implemented in this section by using the
+*eProsima Fast DDS-Gen* tool.
+This additional approach is explained in :ref:`fastddsgen_pubsub_app`.
 
 .. contents::
     :local: