Feature/param integration #1
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Do you want a review or stamp? If the former can you provide context on your changes. |
12458
reviewed
Sep 8, 2024
| /// @return true or false depending on if the key exists or not | ||
| bool handle_update_parameter(const std::string &key, std::variant<bool, int, float, std::string> parameter_val) | ||
| template <typename ParamType> | ||
| std::optional<ParamType> get_live_parameter(const std::string &key) |
There was a problem hiding this comment.
Consider adding documentation for this method
12458
approved these changes
Sep 8, 2024
There was a problem hiding this comment.
Based on my limited understand, LGTM.
It would be helpful to include comments explaining the reasoning behind the design decisions where possible. Also document your methods. This would aid future maintainers.
Also consider adding tests (if possible - not really sure how the testing suite works at the moment).
|
Maybe we should consider writing a code style guide and enforcing documentation styles: |
SreeDan
approved these changes
Sep 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
context:
I am adding in a live parameter handler to the software for use with components internal to the software.
I update the configuration (Configurable base class) handler to both handle live parameters and file-only parameters. the live parameters are loaded first from the file passed in and then are added to a cache internally that then becomes the source of truth for the parameters. this cache can then be updated at runtime by the foxglove parameter interface.
since the configurable base class will have multiple instances running in multiple threads I put the parameter cache (each configurable component has it's own cache) behind a mutex so that the parameter server thread can lock onto that mutex and update it in a thread-safe manor.
I also added a boost signal to the configurable class that gets executed on callback within the foxglove server thread and calls the user implemented signal to handle the parameter updates internally to the configurable component, this allows the "user" of the configurable class within their component to handle live updates the way that they want.
references:
https://www.boost.org/doc/libs/1_84_0/doc/html/signals2/tutorial.html