Skip to content

Commit 93d43c8

Browse files
github-actions[bot]pablogs9
github-actions[bot]
and
pablogs9
authored
micro-ROS Utils API reference auto-update 04-06-2021 09:28 (#317)
Co-authored-by: pablogs9 <pablogs9@users.noreply.github.com>
1 parent 3156b68 commit 93d43c8

1 file changed

Lines changed: 34 additions & 66 deletions

File tree

‎_includes/utils_doc/Modules/group__typeutils.md‎

Lines changed: 34 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -11,28 +11,6 @@
1111
| 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. |
1212
| 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. |
1313

14-
## Attributes
15-
16-
| | Name |
17-
| -------------- | -------------- |
18-
| const micro_ros_utilities_memory_conf_t | **micro_ros_utilities_memory_conf_default** |
19-
20-
## Types Documentation
21-
22-
### typedef micro_ros_utilities_memory_rule_t
23-
24-
```cpp
25-
typedef struct micro_ros_utilities_memory_rule_t micro_ros_utilities_memory_rule_t;
26-
```
27-
28-
29-
### typedef micro_ros_utilities_memory_conf_t
30-
31-
```cpp
32-
typedef struct micro_ros_utilities_memory_conf_t micro_ros_utilities_memory_conf_t;
33-
```
34-
35-
3614

3715
## Functions Documentation
3816

@@ -44,14 +22,14 @@ MICRO_ROS_UTILITIES_PUBLIC rosidl_runtime_c__String micro_ros_utilities_type_inf
4422
)
4523
```
4624

47-
Returns a string with the type instronspection data.
25+
Returns a string with the type instronspection data.
4826

49-
**Parameters**:
27+
**Parameters**:
5028

51-
* **type_support** ROS 2 typesupport
29+
* **type_support** ROS 2 typesupport
5230

5331

54-
**Return**: `rosidl_runtime_c__String` string containing data
32+
**Return**: `rosidl_runtime_c__String` string containing data
5533

5634

5735

@@ -75,15 +53,15 @@ MICRO_ROS_UTILITIES_PUBLIC size_t micro_ros_utilities_get_dynamic_size(
7553
)
7654
```
7755

78-
Returns the dynamic memory size that will be used for a type.
56+
Returns the dynamic memory size that will be used for a type.
7957

80-
**Parameters**:
58+
**Parameters**:
8159

82-
* **type_support** ROS 2 typesupport
83-
* **conf** Utils configurator
60+
* **type_support** ROS 2 typesupport
61+
* **conf** Utils configurator
8462

8563

86-
**Return**: `size_t` Size in Bytes that will be used
64+
**Return**: `size_t` Size in Bytes that will be used
8765

8866

8967

@@ -107,15 +85,15 @@ MICRO_ROS_UTILITIES_PUBLIC size_t micro_ros_utilities_get_static_size(
10785
)
10886
```
10987

110-
Returns the static memory size that will be used for a type.
88+
Returns the static memory size that will be used for a type.
11189

112-
**Parameters**:
90+
**Parameters**:
11391

114-
* **type_support** ROS 2 typesupport
115-
* **conf** Utils configurator
92+
* **type_support** ROS 2 typesupport
93+
* **conf** Utils configurator
11694

11795

118-
**Return**: `size_t` Size in Bytes that will be used
96+
**Return**: `size_t` Size in Bytes that will be used
11997

12098

12199

@@ -140,16 +118,16 @@ MICRO_ROS_UTILITIES_PUBLIC bool micro_ros_utilities_create_message_memory(
140118
)
141119
```
142120

143-
Allocates the dynamic memory required for a message.
121+
Allocates the dynamic memory required for a message.
144122

145-
**Parameters**:
123+
**Parameters**:
146124

147-
* **type_support** ROS 2 typesupport
148-
* **ros_msg** ROS 2 msg with no type
149-
* **conf** Utils configurator
125+
* **type_support** ROS 2 typesupport
126+
* **ros_msg** ROS 2 msg with no type
127+
* **conf** Utils configurator
150128

151129

152-
**Return**: `bool` true if success
130+
**Return**: `bool` true if success
153131

154132

155133

@@ -176,18 +154,18 @@ MICRO_ROS_UTILITIES_PUBLIC bool micro_ros_utilities_create_static_message_memory
176154
)
177155
```
178156

179-
Allocates the memory required for a message in a user-provided buffer.
157+
Allocates the memory required for a message in a user-provided buffer.
180158

181-
**Parameters**:
159+
**Parameters**:
182160

183-
* **type_support** ROS 2 typesupport
184-
* **ros_msg** ROS 2 msg with no type
185-
* **conf** Utils configurator
186-
* **buffer** User buffer
187-
* **buffer_len** User buffer length
161+
* **type_support** ROS 2 typesupport
162+
* **ros_msg** ROS 2 msg with no type
163+
* **conf** Utils configurator
164+
* **buffer** User buffer
165+
* **buffer_len** User buffer length
188166

189167

190-
**Return**: `bool` true if success
168+
**Return**: `bool` true if success
191169

192170

193171

@@ -212,16 +190,16 @@ MICRO_ROS_UTILITIES_PUBLIC bool micro_ros_utilities_destroy_message_memory(
212190
)
213191
```
214192

215-
Deallocates the dynamic memory of a message.
193+
Deallocates the dynamic memory of a message.
216194

217-
**Parameters**:
195+
**Parameters**:
218196

219-
* **type_support** ROS 2 typesupport
220-
* **ros_msg** ROS 2 msg with no type
221-
* **conf** Utils configurator
197+
* **type_support** ROS 2 typesupport
198+
* **ros_msg** ROS 2 msg with no type
199+
* **conf** Utils configurator
222200

223201

224-
**Return**: `bool` true if success
202+
**Return**: `bool` true if success
225203

226204

227205

@@ -237,16 +215,6 @@ Deallocates the dynamic memory of a message.
237215

238216

239217

240-
## Attributes Documentation
241-
242-
### variable micro_ros_utilities_memory_conf_default
243-
244-
```cpp
245-
static const micro_ros_utilities_memory_conf_t micro_ros_utilities_memory_conf_default =
246-
{20, 5, 5, NULL, 0, NULL};
247-
```
248-
249-
250218

251219

252220

0 commit comments

Comments
 (0)