Skip to content

Commit ed97251

Browse files
Acuadros95Acuadros95
authored
micro-ROS Utils API reference auto-update 17-05-2022 07:42
1 parent 9c37b4c commit ed97251

1 file changed

Lines changed: 55 additions & 7 deletions

File tree

‎_includes/utils_doc/Modules/group__typeutils.md‎

Lines changed: 55 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,53 @@
11
# micro-ROS Types Utilities
22

3+
## Classes
4+
5+
| | Name |
6+
| -------------- | -------------- |
7+
| struct | **[micro_ros_utilities_memory_rule_t](Classes/structmicro__ros__utilities__memory__rule__t.md)** <br>Memory rule. |
8+
| struct | **[micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md)** <br>Memory configuration string. |
9+
10+
## Types
11+
12+
| | Name |
13+
| -------------- | -------------- |
14+
| typedef struct [micro_ros_utilities_memory_rule_t](Classes/structmicro__ros__utilities__memory__rule__t.md) | **[micro_ros_utilities_memory_rule_t](Modules/group__typeutils.md#typedef-micro_ros_utilities_memory_rule_t)** <br>Memory rule. |
15+
| typedef struct [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) | **[micro_ros_utilities_memory_conf_t](Modules/group__typeutils.md#typedef-micro_ros_utilities_memory_conf_t)** <br>Memory configuration string. |
16+
317
## Functions
418

519
| | Name |
620
| -------------- | -------------- |
7-
| MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String | **[micro_ros_utilities_type_info](#function-micro_ros_utilities_type_info)**(const rosidl_message_type_support_t * type_support)<br>Returns a string with the type instronspection data. |
8-
| MICRO_ROS_UTILITIES_PUBLIC size_t | **[micro_ros_utilities_get_dynamic_size](#function-micro_ros_utilities_get_dynamic_size)**(const rosidl_message_type_support_t * type_support, const micro_ros_utilities_memory_conf_t conf)<br>Returns the dynamic memory size that will be used for a type. |
9-
| MICRO_ROS_UTILITIES_PUBLIC size_t | **[micro_ros_utilities_get_static_size](#function-micro_ros_utilities_get_static_size)**(const rosidl_message_type_support_t * type_support, const micro_ros_utilities_memory_conf_t conf)<br>Returns the static memory size that will be used for a type. |
10-
| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_create_message_memory](#function-micro_ros_utilities_create_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const micro_ros_utilities_memory_conf_t conf)<br>Allocates the dynamic memory required for a message. |
11-
| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_create_static_message_memory](#function-micro_ros_utilities_create_static_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const micro_ros_utilities_memory_conf_t conf, uint8_t * buffer, size_t buffer_len)<br>Allocates the memory required for a message in a user-provided buffer. |
12-
| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_destroy_message_memory](#function-micro_ros_utilities_destroy_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const micro_ros_utilities_memory_conf_t conf)<br>Deallocates the dynamic memory of a message. |
21+
| MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String | **[micro_ros_utilities_type_info](#function-micro_ros_utilities_type_info)**(const rosidl_message_type_support_t * type_support)<br>Returns a string with the type introspection data. |
22+
| MICRO_ROS_UTILITIES_PUBLIC size_t | **[micro_ros_utilities_get_dynamic_size](#function-micro_ros_utilities_get_dynamic_size)**(const rosidl_message_type_support_t * type_support, const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) conf)<br>Returns the dynamic memory size that will be used for a type. |
23+
| MICRO_ROS_UTILITIES_PUBLIC size_t | **[micro_ros_utilities_get_static_size](#function-micro_ros_utilities_get_static_size)**(const rosidl_message_type_support_t * type_support, const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) conf)<br>Returns the static memory size that will be used for a type. |
24+
| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_create_message_memory](#function-micro_ros_utilities_create_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) conf)<br>Allocates the dynamic memory required for a message. |
25+
| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_create_static_message_memory](#function-micro_ros_utilities_create_static_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) conf, uint8_t * buffer, size_t buffer_len)<br>Allocates the memory required for a message in a user-provided buffer. |
26+
| MICRO_ROS_UTILITIES_PUBLIC bool | **[micro_ros_utilities_destroy_message_memory](#function-micro_ros_utilities_destroy_message_memory)**(const rosidl_message_type_support_t * type_support, void * ros_msg, const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) conf)<br>Deallocates the dynamic memory of a message. |
27+
28+
## Attributes
29+
30+
| | Name |
31+
| -------------- | -------------- |
32+
| const [micro_ros_utilities_memory_conf_t](Classes/structmicro__ros__utilities__memory__conf__t.md) | **[micro_ros_utilities_memory_conf_default](Modules/group__typeutils.md#variable-micro_ros_utilities_memory_conf_default)** |
33+
34+
## Types Documentation
35+
36+
### typedef micro_ros_utilities_memory_rule_t
37+
38+
```cpp
39+
typedef struct micro_ros_utilities_memory_rule_t micro_ros_utilities_memory_rule_t;
40+
```
41+
42+
Memory rule.
43+
44+
### typedef micro_ros_utilities_memory_conf_t
45+
46+
```cpp
47+
typedef struct micro_ros_utilities_memory_conf_t micro_ros_utilities_memory_conf_t;
48+
```
49+
50+
Memory configuration string.
1351

1452

1553
## Functions Documentation
@@ -22,7 +60,7 @@ MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String micro_ros_utilities_type_inf
2260
)
2361
```
2462

25-
Returns a string with the type instronspection data.
63+
Returns a string with the type introspection data.
2664

2765
**Parameters**:
2866

@@ -215,6 +253,16 @@ Deallocates the dynamic memory of a message.
215253

216254

217255

256+
## Attributes Documentation
257+
258+
### variable micro_ros_utilities_memory_conf_default
259+
260+
```cpp
261+
static const micro_ros_utilities_memory_conf_t micro_ros_utilities_memory_conf_default =
262+
{20, 5, 5, NULL, 0, NULL};
263+
```
264+
265+
218266
219267
220268

0 commit comments

Comments
 (0)