Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Modified CMake Build Infrastructure doc for the dynamic data examples #639

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+28 −145
Open

Modified CMake Build Infrastructure doc for the dynamic data examples #639

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03c25ad
Modified CMake Build Infrastructure doc for the dynamic data examples
angelrti Nov 24, 2023
2f5135f
Fixed readme title for dynamic_data_access_union_discrimintaro c++11 …
angelrti Nov 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 4 additions & 17 deletions examples/connext_dds/dynamic_data_access_union_discriminator/c++11/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:

Expand Down Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is relevant. I would just delete the full Cmake Build Infrastructure section from these examples.

API.

For a more comprehensive example on how to build an RTI Connext application
using CMake, please refer to the
Expand Down
19 changes: 3 additions & 16 deletions examples/connext_dds/dynamic_data_access_union_discriminator/c++98/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
19 changes: 3 additions & 16 deletions examples/connext_dds/dynamic_data_access_union_discriminator/c/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
19 changes: 3 additions & 16 deletions examples/connext_dds/dynamic_data_nested_structs/c++11/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
19 changes: 3 additions & 16 deletions examples/connext_dds/dynamic_data_nested_structs/c++98/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
19 changes: 3 additions & 16 deletions examples/connext_dds/dynamic_data_nested_structs/c/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
19 changes: 3 additions & 16 deletions examples/connext_dds/dynamic_data_sequences/c++11/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
19 changes: 3 additions & 16 deletions examples/connext_dds/dynamic_data_sequences/c++98/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
19 changes: 3 additions & 16 deletions examples/connext_dds/dynamic_data_sequences/c/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading