Function rclc_add_parameter_constraint_integer

Function Documentation

rcl_ret_t rclc_add_parameter_constraint_integer(rclc_parameter_server_t *parameter_server, const char *parameter_name, int64_t from_value, int64_t to_value, uint64_t step)

Sets a constraint on an integer parameter. This constraint specification will be returned on describe parameters requests. This method is disabled on user callback execution.

Attribute

Adherence

Allocates Memory

No

Thread-Safe

No

Uses Atomics

No

Lock-Free

No

Parameters:

  • parameter_server – [in] preallocated rclc_parameter_server_t

  • parameter_name – [in] name of the parameter

  • from_value – [in] start value for valid values, inclusive.

  • to_value – [in] end value for valid values, inclusive.

  • step – [in] size of valid steps between the from and to bound.

Returns:

RCL_RET_OK if success