|
| 1 | +// generated from rosidl_generator_c/resource/idl__functions.h.em |
| 2 | +// with input from geometry_msgs:msg/PoseStampedArray.idl |
| 3 | +// generated code does not contain a copyright notice |
| 4 | + |
| 5 | +// IWYU pragma: private, include "geometry_msgs/msg/pose_stamped_array.h" |
| 6 | + |
| 7 | + |
| 8 | +#ifndef GEOMETRY_MSGS__MSG__DETAIL__POSE_STAMPED_ARRAY__FUNCTIONS_H_ |
| 9 | +#define GEOMETRY_MSGS__MSG__DETAIL__POSE_STAMPED_ARRAY__FUNCTIONS_H_ |
| 10 | + |
| 11 | +#ifdef __cplusplus |
| 12 | +extern "C" |
| 13 | +{ |
| 14 | +#endif |
| 15 | + |
| 16 | +#include <stdbool.h> |
| 17 | +#include <stdlib.h> |
| 18 | + |
| 19 | +#include "rosidl_runtime_c/action_type_support_struct.h" |
| 20 | +#include "rosidl_runtime_c/message_type_support_struct.h" |
| 21 | +#include "rosidl_runtime_c/service_type_support_struct.h" |
| 22 | +#include "rosidl_runtime_c/type_description/type_description__struct.h" |
| 23 | +#include "rosidl_runtime_c/type_description/type_source__struct.h" |
| 24 | +#include "rosidl_runtime_c/type_hash.h" |
| 25 | +#include "rosidl_runtime_c/visibility_control.h" |
| 26 | +#include "geometry_msgs/msg/rosidl_generator_c__visibility_control.h" |
| 27 | + |
| 28 | +#include "geometry_msgs/msg/detail/pose_stamped_array__struct.h" |
| 29 | + |
| 30 | +/// Initialize msg/PoseStampedArray message. |
| 31 | +/** |
| 32 | + * If the init function is called twice for the same message without |
| 33 | + * calling fini inbetween previously allocated memory will be leaked. |
| 34 | + * \param[in,out] msg The previously allocated message pointer. |
| 35 | + * Fields without a default value will not be initialized by this function. |
| 36 | + * You might want to call memset(msg, 0, sizeof( |
| 37 | + * geometry_msgs__msg__PoseStampedArray |
| 38 | + * )) before or use |
| 39 | + * geometry_msgs__msg__PoseStampedArray__create() |
| 40 | + * to allocate and initialize the message. |
| 41 | + * \return true if initialization was successful, otherwise false |
| 42 | + */ |
| 43 | +ROSIDL_GENERATOR_C_PUBLIC_geometry_msgs |
| 44 | +bool |
| 45 | +geometry_msgs__msg__PoseStampedArray__init(geometry_msgs__msg__PoseStampedArray * msg); |
| 46 | + |
| 47 | +/// Finalize msg/PoseStampedArray message. |
| 48 | +/** |
| 49 | + * \param[in,out] msg The allocated message pointer. |
| 50 | + */ |
| 51 | +ROSIDL_GENERATOR_C_PUBLIC_geometry_msgs |
| 52 | +void |
| 53 | +geometry_msgs__msg__PoseStampedArray__fini(geometry_msgs__msg__PoseStampedArray * msg); |
| 54 | + |
| 55 | +/// Create msg/PoseStampedArray message. |
| 56 | +/** |
| 57 | + * It allocates the memory for the message, sets the memory to zero, and |
| 58 | + * calls |
| 59 | + * geometry_msgs__msg__PoseStampedArray__init(). |
| 60 | + * \return The pointer to the initialized message if successful, |
| 61 | + * otherwise NULL |
| 62 | + */ |
| 63 | +ROSIDL_GENERATOR_C_PUBLIC_geometry_msgs |
| 64 | +geometry_msgs__msg__PoseStampedArray * |
| 65 | +geometry_msgs__msg__PoseStampedArray__create(void); |
| 66 | + |
| 67 | +/// Destroy msg/PoseStampedArray message. |
| 68 | +/** |
| 69 | + * It calls |
| 70 | + * geometry_msgs__msg__PoseStampedArray__fini() |
| 71 | + * and frees the memory of the message. |
| 72 | + * \param[in,out] msg The allocated message pointer. |
| 73 | + */ |
| 74 | +ROSIDL_GENERATOR_C_PUBLIC_geometry_msgs |
| 75 | +void |
| 76 | +geometry_msgs__msg__PoseStampedArray__destroy(geometry_msgs__msg__PoseStampedArray * msg); |
| 77 | + |
| 78 | +/// Check for msg/PoseStampedArray message equality. |
| 79 | +/** |
| 80 | + * \param[in] lhs The message on the left hand size of the equality operator. |
| 81 | + * \param[in] rhs The message on the right hand size of the equality operator. |
| 82 | + * \return true if messages are equal, otherwise false. |
| 83 | + */ |
| 84 | +ROSIDL_GENERATOR_C_PUBLIC_geometry_msgs |
| 85 | +bool |
| 86 | +geometry_msgs__msg__PoseStampedArray__are_equal(const geometry_msgs__msg__PoseStampedArray * lhs, const geometry_msgs__msg__PoseStampedArray * rhs); |
| 87 | + |
| 88 | +/// Copy a msg/PoseStampedArray message. |
| 89 | +/** |
| 90 | + * This functions performs a deep copy, as opposed to the shallow copy that |
| 91 | + * plain assignment yields. |
| 92 | + * |
| 93 | + * \param[in] input The source message pointer. |
| 94 | + * \param[out] output The target message pointer, which must |
| 95 | + * have been initialized before calling this function. |
| 96 | + * \return true if successful, or false if either pointer is null |
| 97 | + * or memory allocation fails. |
| 98 | + */ |
| 99 | +ROSIDL_GENERATOR_C_PUBLIC_geometry_msgs |
| 100 | +bool |
| 101 | +geometry_msgs__msg__PoseStampedArray__copy( |
| 102 | + const geometry_msgs__msg__PoseStampedArray * input, |
| 103 | + geometry_msgs__msg__PoseStampedArray * output); |
| 104 | + |
| 105 | +/// Retrieve pointer to the hash of the description of this type. |
| 106 | +ROSIDL_GENERATOR_C_PUBLIC_geometry_msgs |
| 107 | +const rosidl_type_hash_t * |
| 108 | +geometry_msgs__msg__PoseStampedArray__get_type_hash( |
| 109 | + const rosidl_message_type_support_t * type_support); |
| 110 | + |
| 111 | +/// Retrieve pointer to the description of this type. |
| 112 | +ROSIDL_GENERATOR_C_PUBLIC_geometry_msgs |
| 113 | +const rosidl_runtime_c__type_description__TypeDescription * |
| 114 | +geometry_msgs__msg__PoseStampedArray__get_type_description( |
| 115 | + const rosidl_message_type_support_t * type_support); |
| 116 | + |
| 117 | +/// Retrieve pointer to the single raw source text that defined this type. |
| 118 | +ROSIDL_GENERATOR_C_PUBLIC_geometry_msgs |
| 119 | +const rosidl_runtime_c__type_description__TypeSource * |
| 120 | +geometry_msgs__msg__PoseStampedArray__get_individual_type_description_source( |
| 121 | + const rosidl_message_type_support_t * type_support); |
| 122 | + |
| 123 | +/// Retrieve pointer to the recursive raw sources that defined the description of this type. |
| 124 | +ROSIDL_GENERATOR_C_PUBLIC_geometry_msgs |
| 125 | +const rosidl_runtime_c__type_description__TypeSource__Sequence * |
| 126 | +geometry_msgs__msg__PoseStampedArray__get_type_description_sources( |
| 127 | + const rosidl_message_type_support_t * type_support); |
| 128 | + |
| 129 | +/// Initialize array of msg/PoseStampedArray messages. |
| 130 | +/** |
| 131 | + * It allocates the memory for the number of elements and calls |
| 132 | + * geometry_msgs__msg__PoseStampedArray__init() |
| 133 | + * for each element of the array. |
| 134 | + * \param[in,out] array The allocated array pointer. |
| 135 | + * \param[in] size The size / capacity of the array. |
| 136 | + * \return true if initialization was successful, otherwise false |
| 137 | + * If the array pointer is valid and the size is zero it is guaranteed |
| 138 | + # to return true. |
| 139 | + */ |
| 140 | +ROSIDL_GENERATOR_C_PUBLIC_geometry_msgs |
| 141 | +bool |
| 142 | +geometry_msgs__msg__PoseStampedArray__Sequence__init(geometry_msgs__msg__PoseStampedArray__Sequence * array, size_t size); |
| 143 | + |
| 144 | +/// Finalize array of msg/PoseStampedArray messages. |
| 145 | +/** |
| 146 | + * It calls |
| 147 | + * geometry_msgs__msg__PoseStampedArray__fini() |
| 148 | + * for each element of the array and frees the memory for the number of |
| 149 | + * elements. |
| 150 | + * \param[in,out] array The initialized array pointer. |
| 151 | + */ |
| 152 | +ROSIDL_GENERATOR_C_PUBLIC_geometry_msgs |
| 153 | +void |
| 154 | +geometry_msgs__msg__PoseStampedArray__Sequence__fini(geometry_msgs__msg__PoseStampedArray__Sequence * array); |
| 155 | + |
| 156 | +/// Create array of msg/PoseStampedArray messages. |
| 157 | +/** |
| 158 | + * It allocates the memory for the array and calls |
| 159 | + * geometry_msgs__msg__PoseStampedArray__Sequence__init(). |
| 160 | + * \param[in] size The size / capacity of the array. |
| 161 | + * \return The pointer to the initialized array if successful, otherwise NULL |
| 162 | + */ |
| 163 | +ROSIDL_GENERATOR_C_PUBLIC_geometry_msgs |
| 164 | +geometry_msgs__msg__PoseStampedArray__Sequence * |
| 165 | +geometry_msgs__msg__PoseStampedArray__Sequence__create(size_t size); |
| 166 | + |
| 167 | +/// Destroy array of msg/PoseStampedArray messages. |
| 168 | +/** |
| 169 | + * It calls |
| 170 | + * geometry_msgs__msg__PoseStampedArray__Sequence__fini() |
| 171 | + * on the array, |
| 172 | + * and frees the memory of the array. |
| 173 | + * \param[in,out] array The initialized array pointer. |
| 174 | + */ |
| 175 | +ROSIDL_GENERATOR_C_PUBLIC_geometry_msgs |
| 176 | +void |
| 177 | +geometry_msgs__msg__PoseStampedArray__Sequence__destroy(geometry_msgs__msg__PoseStampedArray__Sequence * array); |
| 178 | + |
| 179 | +/// Check for msg/PoseStampedArray message array equality. |
| 180 | +/** |
| 181 | + * \param[in] lhs The message array on the left hand size of the equality operator. |
| 182 | + * \param[in] rhs The message array on the right hand size of the equality operator. |
| 183 | + * \return true if message arrays are equal in size and content, otherwise false. |
| 184 | + */ |
| 185 | +ROSIDL_GENERATOR_C_PUBLIC_geometry_msgs |
| 186 | +bool |
| 187 | +geometry_msgs__msg__PoseStampedArray__Sequence__are_equal(const geometry_msgs__msg__PoseStampedArray__Sequence * lhs, const geometry_msgs__msg__PoseStampedArray__Sequence * rhs); |
| 188 | + |
| 189 | +/// Copy an array of msg/PoseStampedArray messages. |
| 190 | +/** |
| 191 | + * This functions performs a deep copy, as opposed to the shallow copy that |
| 192 | + * plain assignment yields. |
| 193 | + * |
| 194 | + * \param[in] input The source array pointer. |
| 195 | + * \param[out] output The target array pointer, which must |
| 196 | + * have been initialized before calling this function. |
| 197 | + * \return true if successful, or false if either pointer |
| 198 | + * is null or memory allocation fails. |
| 199 | + */ |
| 200 | +ROSIDL_GENERATOR_C_PUBLIC_geometry_msgs |
| 201 | +bool |
| 202 | +geometry_msgs__msg__PoseStampedArray__Sequence__copy( |
| 203 | + const geometry_msgs__msg__PoseStampedArray__Sequence * input, |
| 204 | + geometry_msgs__msg__PoseStampedArray__Sequence * output); |
| 205 | + |
| 206 | +#ifdef __cplusplus |
| 207 | +} |
| 208 | +#endif |
| 209 | + |
| 210 | +#endif // GEOMETRY_MSGS__MSG__DETAIL__POSE_STAMPED_ARRAY__FUNCTIONS_H_ |
0 commit comments