@@ -32,18 +32,61 @@ extern "C"
32
32
// Memory rule
33
33
typedef struct micro_ros_utilities_memory_rule_t
34
34
{
35
+ /**
36
+ * Pattern matching the fully qualified name of a msg field.
37
+ *
38
+ */
35
39
const char * rule ;
40
+
41
+ /**
42
+ * Maximum string or sequence capacity for fields matching \ref rule.
43
+ *
44
+ */
36
45
size_t size ;
37
46
} micro_ros_utilities_memory_rule_t ;
38
47
39
48
// Memory configuration string
40
49
typedef struct micro_ros_utilities_memory_conf_t
41
50
{
51
+ /**
52
+ * Maximum string capacity to use for msg fields in case they don't have a
53
+ * custom rule assigned to them.
54
+ *
55
+ */
42
56
size_t max_string_capacity ;
57
+
58
+ /**
59
+ * Maximum capacity to use for sequence type msg fields (ie: unbounded
60
+ * arrays and lists) which contain ROS 2 msg types, in case they don't have
61
+ * a custom rule assigned to them.
62
+ *
63
+ */
43
64
size_t max_ros2_type_sequence_capacity ;
65
+
66
+ /**
67
+ * Maximum capacity to use for sequence type msg fields (ie: unbounded
68
+ * arrays and lists) which contain basic types (ie: primitive field types),
69
+ * in case they don't have a custom rule assigned to them.
70
+ *
71
+ */
44
72
size_t max_basic_type_sequence_capacity ;
73
+
74
+ /**
75
+ * All rules defined in this configuration.
76
+ *
77
+ */
45
78
const micro_ros_utilities_memory_rule_t * rules ;
79
+
80
+ /**
81
+ * Total number of rules defined in this configuration.
82
+ *
83
+ */
46
84
size_t n_rules ;
85
+
86
+ /**
87
+ * The allocator to use when applying this configuration.
88
+ *
89
+ */
47
90
const rcutils_allocator_t * allocator ;
48
91
} micro_ros_utilities_memory_conf_t ;
49
92
@@ -56,7 +99,7 @@ static const micro_ros_utilities_memory_conf_t micro_ros_utilities_memory_conf_d
56
99
*/
57
100
58
101
/**
59
- * Returns a string with the type instronspection data
102
+ * Returns a string with the type introspection data
60
103
*
61
104
* <hr>
62
105
* Attribute | Adherence
0 commit comments