-
Notifications
You must be signed in to change notification settings - Fork 329
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add example of registering custom parameter validation callbacks #273
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
// Copyright 2018 Open Source Robotics Foundation, Inc. | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
#include <memory> | ||
#include <vector> | ||
|
||
#include "rclcpp/rclcpp.hpp" | ||
|
||
class EvenParameterNode : public rclcpp::Node | ||
{ | ||
public: | ||
EvenParameterNode() | ||
: Node("even_parameters_node") | ||
{ | ||
// Declare a parameter change request callback | ||
// This function will enforce that only setting even integer parameters is allowed | ||
// any other change will be discarded | ||
auto param_change_callback = | ||
[this](std::vector<rclcpp::Parameter> parameters) -> rcl_interfaces::msg::SetParametersResult | ||
{ | ||
auto result = rcl_interfaces::msg::SetParametersResult(); | ||
result.successful = true; | ||
for (auto parameter : parameters) { | ||
rclcpp::ParameterType parameter_type = parameter.get_type(); | ||
if (rclcpp::ParameterType::PARAMETER_NOT_SET == parameter_type) { | ||
RCLCPP_INFO(this->get_logger(), | ||
"parameter '%s' deleted successfully", | ||
parameter.get_name().c_str() | ||
); | ||
result.successful &= true; | ||
} else if (rclcpp::ParameterType::PARAMETER_INTEGER == parameter_type) { | ||
if (parameter.as_int() % 2 != 0) { | ||
RCLCPP_INFO(this->get_logger(), | ||
"Requested value '%d' for parameter '%s' is not an even number:" | ||
" rejecting change...", | ||
parameter.as_int(), | ||
parameter.get_name().c_str() | ||
); | ||
result.successful = false; | ||
} else { | ||
RCLCPP_INFO(this->get_logger(), | ||
"parameter '%s' has changed and is now %s", | ||
parameter.get_name().c_str(), | ||
parameter.value_to_string().c_str() | ||
); | ||
result.successful &= true; | ||
} | ||
} else { | ||
RCLCPP_INFO(this->get_logger(), | ||
"only integer parameters can be set\n" | ||
"requested value for parameter '%s' is not an even number, rejecting change...", | ||
parameter.get_name().c_str() | ||
); | ||
result.successful = false; | ||
} | ||
} | ||
return result; | ||
}; | ||
this->register_param_change_callback(param_change_callback); | ||
} | ||
}; | ||
|
||
int main(int argc, char ** argv) | ||
{ | ||
// Force flush of the stdout buffer. | ||
setvbuf(stdout, NULL, _IONBF, BUFSIZ); | ||
|
||
rclcpp::init(argc, argv); | ||
|
||
auto node = std::make_shared<EvenParameterNode>(); | ||
|
||
rclcpp::spin(node); | ||
rclcpp::shutdown(); | ||
return 0; | ||
} |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Might want to quote the second
%s
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or use a
: %s
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, I purposefully avoided the quoting as I was afraid it could confuse users into thinking that a string value was set and not an integer.
I went for the 2nd approach in 6109880