Commit 07dc0a96 authored by Evgeny Kusmenko's avatar Evgeny Kusmenko
Browse files

Merge branch 'Documentation' into 'master'

Fix: code block rendering

See merge request !6
parents 6109fc9c 8a487b9a
Pipeline #58194 passed with stage
in 2 minutes and 28 seconds
...@@ -29,6 +29,7 @@ All examples are given for the middleware ROS and a component named `AddComp` fr ...@@ -29,6 +29,7 @@ All examples are given for the middleware ROS and a component named `AddComp` fr
* Example: `class RosAdapter_tests_a_addComp` in `RosAdapter_tests_a_addComp.h` * Example: `class RosAdapter_tests_a_addComp` in `RosAdapter_tests_a_addComp.h`
* **Interfaces:** The generated coordinator for the Component contains the interface `IAdapter_{Component.fullQualifiedName}.h` which the new Adapter needs to implement. * **Interfaces:** The generated coordinator for the Component contains the interface `IAdapter_{Component.fullQualifiedName}.h` which the new Adapter needs to implement.
* Example: * Example:
``` ```
#include "IAdapter_tests_a_addComp.h" #include "IAdapter_tests_a_addComp.h"
... ...
...@@ -36,6 +37,7 @@ All examples are given for the middleware ROS and a component named `AddComp` fr ...@@ -36,6 +37,7 @@ All examples are given for the middleware ROS and a component named `AddComp` fr
``` ```
* **init method:** The Interface contains the Method ``init({Component.fullQualifiedName}* comp)`` that sets the shared instance of the Component and starts the middleware in this thread. * **init method:** The Interface contains the Method ``init({Component.fullQualifiedName}* comp)`` that sets the shared instance of the Component and starts the middleware in this thread.
* Example: * Example:
``` ```
#include "tests_a_addComp.h" #include "tests_a_addComp.h"
#include <ros/ros.h> #include <ros/ros.h>
...@@ -50,6 +52,7 @@ All examples are given for the middleware ROS and a component named `AddComp` fr ...@@ -50,6 +52,7 @@ All examples are given for the middleware ROS and a component named `AddComp` fr
``` ```
* **tick method:** The Interface contains the Method `tick()` that the coordinator executes in an defined interval(e.g. every 100ms). The middleware needs to publish all outgoing connections in this method. Do not call `component.execute()` here, as the coordinator aleady does that! * **tick method:** The Interface contains the Method `tick()` that the coordinator executes in an defined interval(e.g. every 100ms). The middleware needs to publish all outgoing connections in this method. Do not call `component.execute()` here, as the coordinator aleady does that!
* Example: * Example:
``` ```
void tick(){ void tick(){
//publish the values of the out1 Port of the Component to ROS //publish the values of the out1 Port of the Component to ROS
...@@ -65,6 +68,7 @@ All examples are given for the middleware ROS and a component named `AddComp` fr ...@@ -65,6 +68,7 @@ All examples are given for the middleware ROS and a component named `AddComp` fr
4. The C++ code for the a) Component and b) Coordinator must be linked/included 4. The C++ code for the a) Component and b) Coordinator must be linked/included
5. All includes and the header file for the adapter need to be accessible from the super project 5. All includes and the header file for the adapter need to be accessible from the super project
* Example: * Example:
``` ```
cmake_minimum_required(VERSION 3.5) cmake_minimum_required(VERSION 3.5)
#see i. #see i.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment