Skip to content

micro-ROS Utils API reference auto-update 13-06-2023 12:21 #409

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

Merged
Acuadros95 merged 1 commit into from
Jun 13, 2023
Merged

micro-ROS Utils API reference auto-update 13-06-2023 12:21 #409

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
74 changes: 37 additions & 37 deletions _includes/utils_doc/Modules/group__stringutils.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
| MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String | **[micro_ros_string_utilities_init](#function-micro_ros_string_utilities_init)**(const char * data)<br>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)<br>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)**(const rosidl_runtime_c__String str, const char * data)<br>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)**(const rosidl_runtime_c__String str)<br>Returns the char pointer to the rosidl_runtime_c__String data. |
| MICRO_ROS_UTILITIES_PUBLIC const char * | **[micro_ros_string_utilities_get_c_str](#function-micro_ros_string_utilities_get_c_str)**(const rosidl_runtime_c__String str)<br>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)**(const rosidl_runtime_c__String str, const char * data)<br>Appends a char pointer to the end of a rosidl_runtime_c__String. |
| MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String | **[micro_ros_string_utilities_remove_tail_chars](#function-micro_ros_string_utilities_remove_tail_chars)**(const rosidl_runtime_c__String str, const size_t n)<br>Removes characters from the end of a string. |
| MICRO_ROS_UTILITIES_PUBLIC void | **[micro_ros_string_utilities_destroy](#function-micro_ros_string_utilities_destroy)**(rosidl_runtime_c__String *const str)<br>Destroys a rosidl_runtime_c__String. |
Expand Down Expand Up @@ -36,12 +36,12 @@ Create a rosidl_runtime_c__String from a char pointer.
------------------


| Attribute | Adherence |
| Attribute | Adherence |
| -------- | -------- |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |


### function micro_ros_string_utilities_init_with_size
Expand All @@ -66,12 +66,12 @@ Create a rosidl_runtime_c__String from a size.
------------------


| Attribute | Adherence |
| Attribute | Adherence |
| -------- | -------- |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |


### function micro_ros_string_utilities_set
Expand All @@ -98,18 +98,18 @@ Create a rosidl_runtime_c__String from a char pointer.
------------------


| Attribute | Adherence |
| Attribute | Adherence |
| -------- | -------- |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |


### function micro_ros_string_utilities_get_c_str

```cpp
const MICRO_ROS_UTILITIES_PUBLIC char * micro_ros_string_utilities_get_c_str(
MICRO_ROS_UTILITIES_PUBLIC const char * micro_ros_string_utilities_get_c_str(
const rosidl_runtime_c__String str
)
```
Expand All @@ -128,12 +128,12 @@ Returns the char pointer to the rosidl_runtime_c__String data.
------------------


| Attribute | Adherence |
| Attribute | Adherence |
| -------- | -------- |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |


### function micro_ros_string_utilities_append
Expand All @@ -160,12 +160,12 @@ Appends a char pointer to the end of a rosidl_runtime_c__String.
------------------


| Attribute | Adherence |
| Attribute | Adherence |
| -------- | -------- |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |


### function micro_ros_string_utilities_remove_tail_chars
Expand All @@ -192,12 +192,12 @@ Removes characters from the end of a string.
------------------


| Attribute | Adherence |
| Attribute | Adherence |
| -------- | -------- |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |


### function micro_ros_string_utilities_destroy
Expand All @@ -220,12 +220,12 @@ Destroys a rosidl_runtime_c__String.
------------------


| Attribute | Adherence |
| Attribute | Adherence |
| -------- | -------- |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |



Expand Down
60 changes: 30 additions & 30 deletions _includes/utils_doc/Modules/group__typeutils.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@ Returns a string with the type introspection data.
------------------


| Attribute | Adherence |
| Attribute | Adherence |
| -------- | -------- |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |


### function micro_ros_utilities_get_dynamic_size
Expand All @@ -74,12 +74,12 @@ Returns the dynamic memory size that will be used for a type.
------------------


| Attribute | Adherence |
| Attribute | Adherence |
| -------- | -------- |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |


### function micro_ros_utilities_get_static_size
Expand All @@ -106,12 +106,12 @@ Returns the static memory size that will be used for a type.
------------------


| Attribute | Adherence |
| Attribute | Adherence |
| -------- | -------- |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |


### function micro_ros_utilities_create_message_memory
Expand Down Expand Up @@ -140,12 +140,12 @@ Allocates the dynamic memory required for a message.
------------------


| Attribute | Adherence |
| Attribute | Adherence |
| -------- | -------- |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |


### function micro_ros_utilities_create_static_message_memory
Expand Down Expand Up @@ -178,12 +178,12 @@ Allocates the memory required for a message in a user-provided buffer.
------------------


| Attribute | Adherence |
| Attribute | Adherence |
| -------- | -------- |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |


### function micro_ros_utilities_destroy_message_memory
Expand Down Expand Up @@ -212,12 +212,12 @@ Deallocates the dynamic memory of a message.
------------------


| Attribute | Adherence |
| Attribute | Adherence |
| -------- | -------- |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |
| Allocates Memory | Yes |
| Thread-Safe | No |
| Uses Atomics | No |
| Lock-Free | Yes |



Expand Down