[Draft]Add structured parameter support #1494
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Original GSOC proposal here. Adds additional API that allows the user to access structured YAML parameters as
dict()inrclpy.Essentially, given a parameter YAML file such as
In the code, the user can declare a structured yaml parameter as
And get access to all the elements under
passenger_sizeasThey can then access individual fields using the standard
dict()syntaxUsers can also now set yaml parameters through the
ros2CLI. The syntax is very similar to the one already used for setting messages. For example:will change passenger size as
Fixes # (issue)
Is this user-facing behavior change?
Yes, it adds an additional parameter type that they can use. None of the existing parameter types are affected. Support for namespaced existing namespaced parameters is not affected. If required users will still be able to access individual namespaced parameters such as
passenger_size.min.x,passenger_size.max.x, etc.Did you use Generative AI?
No.
Additional Information
rclPR: [Draft]Add structured parameter support rcl#1254rclcppPR: [Draft]Add structured parameter support rclcpp#2944rcl_interfacesPR: Add structured parameter support rcl_interfaces#183