From 03c25ad8a1f80d601019918beaf42980324bafa6 Mon Sep 17 00:00:00 2001 From: Angel Martinez Date: Fri, 24 Nov 2023 11:57:48 +0100 Subject: [PATCH 1/2] Modified CMake Build Infrastructure doc for the dynamic data examples --- .../c++11/README.md | 19 +++---------------- .../c++98/README.md | 19 +++---------------- .../c/README.md | 19 +++---------------- .../c++11/README.md | 19 +++---------------- .../c++98/README.md | 19 +++---------------- .../dynamic_data_nested_structs/c/README.md | 19 +++---------------- .../dynamic_data_sequences/c++11/README.md | 19 +++---------------- .../dynamic_data_sequences/c++98/README.md | 19 +++---------------- .../dynamic_data_sequences/c/README.md | 19 +++---------------- 9 files changed, 27 insertions(+), 144 deletions(-) diff --git a/examples/connext_dds/dynamic_data_access_union_discriminator/c++11/README.md b/examples/connext_dds/dynamic_data_access_union_discriminator/c++11/README.md index 8b660f07e..8280c12a4 100644 --- a/examples/connext_dds/dynamic_data_access_union_discriminator/c++11/README.md +++ b/examples/connext_dds/dynamic_data_access_union_discriminator/c++11/README.md @@ -101,22 +101,9 @@ cmake -DCONNEXTDDS_ARCH=x64Linux3gcc5.4.0 .. ### CMake Build Infrastructure -The `CMakeListst.txt` script that builds this example uses a generic CMake -function called `connextdds_add_example` that defines all the necessary constructs -to: - -1. Run RTI Code Generator to generate the serialization/deserialization code - for the types defined in the IDL file associated with the example. - -2. Build the corresponding Publisher and Subscriber applications. - -3. Copy the `USER_QOS_PROFILES.xml` file into the directory where the publisher - and subscriber executables are generated. - -You will find the definition of `connextdds_add_example`, along with detailed -documentation, in -[resources/cmake/rticonnextdds-cmake-utils/cmake/Modules/ConnextDdsAddExample.cmake -](https://github.com/rticommunity/rticonnextdds-cmake-utils/blob/main/cmake/Modules/ConnextDdsAddExample.cmake). +This example does not require the usage of rtiddsgen. Therefore, the +`CMakeLists.txt` script just creates the executable and link it with the Connext +API. For a more comprehensive example on how to build an RTI Connext application using CMake, please refer to the diff --git a/examples/connext_dds/dynamic_data_access_union_discriminator/c++98/README.md b/examples/connext_dds/dynamic_data_access_union_discriminator/c++98/README.md index 0def33bb8..5282e2603 100644 --- a/examples/connext_dds/dynamic_data_access_union_discriminator/c++98/README.md +++ b/examples/connext_dds/dynamic_data_access_union_discriminator/c++98/README.md @@ -101,22 +101,9 @@ cmake -DCONNEXTDDS_ARCH=x64Linux3gcc5.4.0 .. ### CMake Build Infrastructure -The `CMakeListst.txt` script that builds this example uses a generic CMake -function called `connextdds_add_example` that defines all the necessary constructs -to: - -1. Run RTI Code Generator to generate the serialization/deserialization code - for the types defined in the IDL file associated with the example. - -2. Build the corresponding Publisher and Subscriber applications. - -3. Copy the `USER_QOS_PROFILES.xml` file into the directory where the publisher - and subscriber executables are generated. - -You will find the definition of `connextdds_add_example`, along with detailed -documentation, in -[resources/cmake/rticonnextdds-cmake-utils/cmake/Modules/ConnextDdsAddExample.cmake -](https://github.com/rticommunity/rticonnextdds-cmake-utils/blob/main/cmake/Modules/ConnextDdsAddExample.cmake). +This example does not require the usage of rtiddsgen. Therefore, the +`CMakeLists.txt` script just creates the executable and link it with the Connext +API. For a more comprehensive example on how to build an RTI Connext application using CMake, please refer to the diff --git a/examples/connext_dds/dynamic_data_access_union_discriminator/c/README.md b/examples/connext_dds/dynamic_data_access_union_discriminator/c/README.md index 0def33bb8..5282e2603 100644 --- a/examples/connext_dds/dynamic_data_access_union_discriminator/c/README.md +++ b/examples/connext_dds/dynamic_data_access_union_discriminator/c/README.md @@ -101,22 +101,9 @@ cmake -DCONNEXTDDS_ARCH=x64Linux3gcc5.4.0 .. ### CMake Build Infrastructure -The `CMakeListst.txt` script that builds this example uses a generic CMake -function called `connextdds_add_example` that defines all the necessary constructs -to: - -1. Run RTI Code Generator to generate the serialization/deserialization code - for the types defined in the IDL file associated with the example. - -2. Build the corresponding Publisher and Subscriber applications. - -3. Copy the `USER_QOS_PROFILES.xml` file into the directory where the publisher - and subscriber executables are generated. - -You will find the definition of `connextdds_add_example`, along with detailed -documentation, in -[resources/cmake/rticonnextdds-cmake-utils/cmake/Modules/ConnextDdsAddExample.cmake -](https://github.com/rticommunity/rticonnextdds-cmake-utils/blob/main/cmake/Modules/ConnextDdsAddExample.cmake). +This example does not require the usage of rtiddsgen. Therefore, the +`CMakeLists.txt` script just creates the executable and link it with the Connext +API. For a more comprehensive example on how to build an RTI Connext application using CMake, please refer to the diff --git a/examples/connext_dds/dynamic_data_nested_structs/c++11/README.md b/examples/connext_dds/dynamic_data_nested_structs/c++11/README.md index 949c39b8e..61b0d06cb 100644 --- a/examples/connext_dds/dynamic_data_nested_structs/c++11/README.md +++ b/examples/connext_dds/dynamic_data_nested_structs/c++11/README.md @@ -152,22 +152,9 @@ cmake -DCONNEXTDDS_ARCH=x64Linux3gcc5.4.0 .. ### CMake Build Infrastructure -The `CMakeListst.txt` script that builds this example uses a generic CMake -function called `connextdds_add_example` that defines all the necessary constructs -to: - -1. Run RTI Code Generator to generate the serialization/deserialization code - for the types defined in the IDL file associated with the example. - -2. Build the corresponding Publisher and Subscriber applications. - -3. Copy the `USER_QOS_PROFILES.xml` file into the directory where the publisher - and subscriber executables are generated. - -You will find the definition of `connextdds_add_example`, along with detailed -documentation, in -[resources/cmake/rticonnextdds-cmake-utils/cmake/Modules/ConnextDdsAddExample.cmake -](https://github.com/rticommunity/rticonnextdds-cmake-utils/blob/main/cmake/Modules/ConnextDdsAddExample.cmake). +This example does not require the usage of rtiddsgen. Therefore, the +`CMakeLists.txt` script just creates the executable and link it with the Connext +API. For a more comprehensive example on how to build an RTI Connext application using CMake, please refer to the diff --git a/examples/connext_dds/dynamic_data_nested_structs/c++98/README.md b/examples/connext_dds/dynamic_data_nested_structs/c++98/README.md index 5ff515d2c..36655f3fc 100644 --- a/examples/connext_dds/dynamic_data_nested_structs/c++98/README.md +++ b/examples/connext_dds/dynamic_data_nested_structs/c++98/README.md @@ -166,22 +166,9 @@ cmake -DCONNEXTDDS_ARCH=x64Linux3gcc5.4.0 .. ### CMake Build Infrastructure -The `CMakeListst.txt` script that builds this example uses a generic CMake -function called `connextdds_add_example` that defines all the necessary constructs -to: - -1. Run RTI Code Generator to generate the serialization/deserialization code - for the types defined in the IDL file associated with the example. - -2. Build the corresponding Publisher and Subscriber applications. - -3. Copy the `USER_QOS_PROFILES.xml` file into the directory where the publisher - and subscriber executables are generated. - -You will find the definition of `connextdds_add_example`, along with detailed -documentation, in -[resources/cmake/rticonnextdds-cmake-utils/cmake/Modules/ConnextDdsAddExample.cmake -](https://github.com/rticommunity/rticonnextdds-cmake-utils/blob/main/cmake/Modules/ConnextDdsAddExample.cmake). +This example does not require the usage of rtiddsgen. Therefore, the +`CMakeLists.txt` script just creates the executable and link it with the Connext +API. For a more comprehensive example on how to build an RTI Connext application using CMake, please refer to the diff --git a/examples/connext_dds/dynamic_data_nested_structs/c/README.md b/examples/connext_dds/dynamic_data_nested_structs/c/README.md index 5ff515d2c..36655f3fc 100644 --- a/examples/connext_dds/dynamic_data_nested_structs/c/README.md +++ b/examples/connext_dds/dynamic_data_nested_structs/c/README.md @@ -166,22 +166,9 @@ cmake -DCONNEXTDDS_ARCH=x64Linux3gcc5.4.0 .. ### CMake Build Infrastructure -The `CMakeListst.txt` script that builds this example uses a generic CMake -function called `connextdds_add_example` that defines all the necessary constructs -to: - -1. Run RTI Code Generator to generate the serialization/deserialization code - for the types defined in the IDL file associated with the example. - -2. Build the corresponding Publisher and Subscriber applications. - -3. Copy the `USER_QOS_PROFILES.xml` file into the directory where the publisher - and subscriber executables are generated. - -You will find the definition of `connextdds_add_example`, along with detailed -documentation, in -[resources/cmake/rticonnextdds-cmake-utils/cmake/Modules/ConnextDdsAddExample.cmake -](https://github.com/rticommunity/rticonnextdds-cmake-utils/blob/main/cmake/Modules/ConnextDdsAddExample.cmake). +This example does not require the usage of rtiddsgen. Therefore, the +`CMakeLists.txt` script just creates the executable and link it with the Connext +API. For a more comprehensive example on how to build an RTI Connext application using CMake, please refer to the diff --git a/examples/connext_dds/dynamic_data_sequences/c++11/README.md b/examples/connext_dds/dynamic_data_sequences/c++11/README.md index dcf17ff91..542413f1c 100644 --- a/examples/connext_dds/dynamic_data_sequences/c++11/README.md +++ b/examples/connext_dds/dynamic_data_sequences/c++11/README.md @@ -101,22 +101,9 @@ cmake -DCONNEXTDDS_ARCH=x64Linux3gcc5.4.0 .. ### CMake Build Infrastructure -The `CMakeListst.txt` script that builds this example uses a generic CMake -function called `connextdds_add_example` that defines all the necessary constructs -to: - -1. Run RTI Code Generator to generate the serialization/deserialization code - for the types defined in the IDL file associated with the example. - -2. Build the corresponding Publisher and Subscriber applications. - -3. Copy the `USER_QOS_PROFILES.xml` file into the directory where the publisher - and subscriber executables are generated. - -You will find the definition of `connextdds_add_example`, along with detailed -documentation, in -[resources/cmake/rticonnextdds-cmake-utils/cmake/Modules/ConnextDdsAddExample.cmake -](https://github.com/rticommunity/rticonnextdds-cmake-utils/blob/main/cmake/Modules/ConnextDdsAddExample.cmake). +This example does not require the usage of rtiddsgen. Therefore, the +`CMakeLists.txt` script just creates the executable and link it with the Connext +API. For a more comprehensive example on how to build an RTI Connext application using CMake, please refer to the diff --git a/examples/connext_dds/dynamic_data_sequences/c++98/README.md b/examples/connext_dds/dynamic_data_sequences/c++98/README.md index dcf17ff91..542413f1c 100644 --- a/examples/connext_dds/dynamic_data_sequences/c++98/README.md +++ b/examples/connext_dds/dynamic_data_sequences/c++98/README.md @@ -101,22 +101,9 @@ cmake -DCONNEXTDDS_ARCH=x64Linux3gcc5.4.0 .. ### CMake Build Infrastructure -The `CMakeListst.txt` script that builds this example uses a generic CMake -function called `connextdds_add_example` that defines all the necessary constructs -to: - -1. Run RTI Code Generator to generate the serialization/deserialization code - for the types defined in the IDL file associated with the example. - -2. Build the corresponding Publisher and Subscriber applications. - -3. Copy the `USER_QOS_PROFILES.xml` file into the directory where the publisher - and subscriber executables are generated. - -You will find the definition of `connextdds_add_example`, along with detailed -documentation, in -[resources/cmake/rticonnextdds-cmake-utils/cmake/Modules/ConnextDdsAddExample.cmake -](https://github.com/rticommunity/rticonnextdds-cmake-utils/blob/main/cmake/Modules/ConnextDdsAddExample.cmake). +This example does not require the usage of rtiddsgen. Therefore, the +`CMakeLists.txt` script just creates the executable and link it with the Connext +API. For a more comprehensive example on how to build an RTI Connext application using CMake, please refer to the diff --git a/examples/connext_dds/dynamic_data_sequences/c/README.md b/examples/connext_dds/dynamic_data_sequences/c/README.md index dcf17ff91..542413f1c 100644 --- a/examples/connext_dds/dynamic_data_sequences/c/README.md +++ b/examples/connext_dds/dynamic_data_sequences/c/README.md @@ -101,22 +101,9 @@ cmake -DCONNEXTDDS_ARCH=x64Linux3gcc5.4.0 .. ### CMake Build Infrastructure -The `CMakeListst.txt` script that builds this example uses a generic CMake -function called `connextdds_add_example` that defines all the necessary constructs -to: - -1. Run RTI Code Generator to generate the serialization/deserialization code - for the types defined in the IDL file associated with the example. - -2. Build the corresponding Publisher and Subscriber applications. - -3. Copy the `USER_QOS_PROFILES.xml` file into the directory where the publisher - and subscriber executables are generated. - -You will find the definition of `connextdds_add_example`, along with detailed -documentation, in -[resources/cmake/rticonnextdds-cmake-utils/cmake/Modules/ConnextDdsAddExample.cmake -](https://github.com/rticommunity/rticonnextdds-cmake-utils/blob/main/cmake/Modules/ConnextDdsAddExample.cmake). +This example does not require the usage of rtiddsgen. Therefore, the +`CMakeLists.txt` script just creates the executable and link it with the Connext +API. For a more comprehensive example on how to build an RTI Connext application using CMake, please refer to the From 2f5135f3798717b6ac8aefda98af5866fc37660c Mon Sep 17 00:00:00 2001 From: Angel Martinez Date: Fri, 24 Nov 2023 18:36:43 +0100 Subject: [PATCH 2/2] Fixed readme title for dynamic_data_access_union_discrimintaro c++11 example --- .../dynamic_data_access_union_discriminator/c++11/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/connext_dds/dynamic_data_access_union_discriminator/c++11/README.md b/examples/connext_dds/dynamic_data_access_union_discriminator/c++11/README.md index 8280c12a4..f4db4f768 100644 --- a/examples/connext_dds/dynamic_data_access_union_discriminator/c++11/README.md +++ b/examples/connext_dds/dynamic_data_access_union_discriminator/c++11/README.md @@ -1,4 +1,4 @@ -# Example code: Using Dynamic Data to publish and subscribe +# Example code: Access Union Discriminators in Dynamic Data ## Building the Example :wrench: