File tree Expand file tree Collapse file tree 1 file changed +11
-0
lines changed
control_toolbox/include/control_toolbox Expand file tree Collapse file tree 1 file changed +11
-0
lines changed Original file line number Diff line number Diff line change @@ -144,6 +144,11 @@ class PidROS
144144 tracking_time_constant parameter to tune the anti-windup behavior. When a strategy
145145 other than 'none' is selected, it will override the controller's default
146146 anti-windup behavior.
147+ * \deprecated{only when `antiwindup_strat == AntiwindupStrategy::NONE`:}
148+ * Old anti-windup technique is deprecated and will be removed by
149+ * the ROS 2 Kilted Kaiju release.
150+ * \warning{If you pass `AntiwindupStrategy::NONE`, at runtime a warning will be printed:}
151+ * `"Old anti-windup technique is deprecated. This option will be removed by the ROS 2 Kilted Kaiju release."`
147152 * \param save_i_term save integrator output between resets.
148153 *
149154 * \note New gains are not applied if i_min_ > i_max_ or if u_min_ > u_max_.
@@ -244,6 +249,12 @@ class PidROS
244249 tracking_time_constant parameter to tune the anti-windup behavior. When a strategy
245250 other than 'none' is selected, it will override the controller's default
246251 anti-windup behavior.
252+ * \deprecated{only when `antiwindup_strat == AntiwindupStrategy::NONE`:}
253+ * Old anti-windup technique is deprecated and will be removed by
254+ * the ROS 2 Kilted Kaiju release.
255+ * \warning{If you pass `AntiwindupStrategy::NONE`, at runtime a warning will be printed:}
256+ * `"Old anti-windup technique is deprecated. This option will be removed by
257+ * the ROS 2 Kilted Kaiju release."`
247258 *
248259 * \note New gains are not applied if i_min > i_max or if u_min_ > u_max_.
249260 */
You can’t perform that action at this time.
0 commit comments