From e5b6fd844bb71e8a44ed74925a8627c9e88ccd0f Mon Sep 17 00:00:00 2001 From: pablogs9 Date: Tue, 13 Jul 2021 06:28:42 +0000 Subject: [PATCH] micro-ROS Utils API reference auto-update 13-07-2021 06:28 --- .../utils_doc/Modules/group__stringutils.md | 31 +++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/_includes/utils_doc/Modules/group__stringutils.md b/_includes/utils_doc/Modules/group__stringutils.md index 553dd256..1b9049f9 100644 --- a/_includes/utils_doc/Modules/group__stringutils.md +++ b/_includes/utils_doc/Modules/group__stringutils.md @@ -5,6 +5,7 @@ | | Name | | -------------- | -------------- | | MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String | **[micro_ros_string_utilities_init](#function-micro_ros_string_utilities_init)**(const char * data)
Create a rosidl_runtime_c__String from a char pointer. | +| MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String | **[micro_ros_string_utilities_init_with_size](#function-micro_ros_string_utilities_init_with_size)**(const size_t size)
Create a rosidl_runtime_c__String from a size. | | MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String | **[micro_ros_string_utilities_set](#function-micro_ros_string_utilities_set)**(rosidl_runtime_c__String str, const char * data)
Create a rosidl_runtime_c__String from a char pointer. | | const MICRO_ROS_UTILITIES_PUBLIC char * | **[micro_ros_string_utilities_get_c_str](#function-micro_ros_string_utilities_get_c_str)**(rosidl_runtime_c__String str)
Returns the char pointer to the rosidl_runtime_c__String data. | | rosidl_runtime_c__String | **[micro_ros_string_utilities_append](#function-micro_ros_string_utilities_append)**(rosidl_runtime_c__String str, const char * data)
Appends a char pointer to the end of a rosidl_runtime_c__String. | @@ -33,6 +34,36 @@ Create a rosidl_runtime_c__String from a char pointer. +------------------ + + +| Attribute | Adherence | +| -------- | -------- | +| Allocates Memory | Yes | +| Thread-Safe | No | +| Uses Atomics | No | +| Lock-Free | Yes | + + +### function micro_ros_string_utilities_init_with_size + +```cpp +MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String micro_ros_string_utilities_init_with_size( + const size_t size +) +``` + +Create a rosidl_runtime_c__String from a size. + +**Parameters**: + + * **size** size of the required string + + +**Return**: `rosidl_runtime_c__String` string of size size + + + ------------------