Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 64 additions & 3 deletions rclcpp/src/rclcpp/node_interfaces/node_parameters.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,54 @@ format_range_reason(const std::string & name, const char * range_type)
return ss.str();
}

static
std::string
format_range_type_reason(
const std::string & name,
const char * range_type,
rclcpp::ParameterType parameter_type)
{
std::ostringstream ss;
ss << "Parameter {" << name << "} of type {" << rclcpp::to_string(parameter_type) <<
"} cannot use " << range_type << " range constraints.";
return ss.str();
}

RCLCPP_LOCAL
rcl_interfaces::msg::SetParametersResult
__check_parameter_type_supports_range(
const rcl_interfaces::msg::ParameterDescriptor & descriptor,
rclcpp::ParameterType parameter_type)
{
rcl_interfaces::msg::SetParametersResult result;
result.successful = true;

if (parameter_type == rclcpp::PARAMETER_NOT_SET) {
return result;
}

if (
!descriptor.integer_range.empty() &&
parameter_type != rclcpp::PARAMETER_INTEGER &&
parameter_type != rclcpp::PARAMETER_INTEGER_ARRAY)
{
result.successful = false;
result.reason = format_range_type_reason(descriptor.name, "integer", parameter_type);
return result;
}

if (
!descriptor.floating_point_range.empty() &&
parameter_type != rclcpp::PARAMETER_DOUBLE &&
parameter_type != rclcpp::PARAMETER_DOUBLE_ARRAY)
{
result.successful = false;
result.reason = format_range_type_reason(descriptor.name, "floating point", parameter_type);
}

return result;
}

RCLCPP_LOCAL
rcl_interfaces::msg::SetParametersResult
__check_integer_range(
Expand Down Expand Up @@ -260,8 +308,11 @@ __check_parameter_value_in_range(
const rcl_interfaces::msg::ParameterDescriptor & descriptor,
const rclcpp::ParameterValue & value)
{
rcl_interfaces::msg::SetParametersResult result;
result.successful = true;
auto result = __check_parameter_type_supports_range(descriptor, value.get_type());
if (!result.successful) {
return result;
}

if (!descriptor.integer_range.empty() && value.get_type() == rclcpp::PARAMETER_INTEGER) {
result = __check_integer_range(descriptor, value.get<int64_t>());
return result;
Expand Down Expand Up @@ -508,6 +559,17 @@ __declare_parameter_common(

// If there is no initial value, then skip initialization
if (initial_value->get_type() == rclcpp::PARAMETER_NOT_SET) {
rcl_interfaces::msg::SetParametersResult result;
if (!parameter_descriptor.dynamic_typing) {
auto descriptor = parameter_descriptor;
descriptor.name = name;
result = __check_parameter_type_supports_range(
descriptor, static_cast<rclcpp::ParameterType>(descriptor.type));
if (!result.successful) {
return result;
}
}

// Add declared parameters to storage (without a value)
parameter_infos[name].descriptor.name = name;
if (parameter_descriptor.dynamic_typing) {
Expand All @@ -516,7 +578,6 @@ __declare_parameter_common(
parameter_infos[name].descriptor.type = parameter_descriptor.type;
}
parameters_out[name] = parameter_infos.at(name);
rcl_interfaces::msg::SetParametersResult result;
result.successful = true;
return result;
}
Expand Down
33 changes: 33 additions & 0 deletions rclcpp/test/rclcpp/test_node.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -559,6 +559,39 @@ TEST_F(TestNode, declare_parameter_with_no_initial_values) {
}
}

TEST_F(TestNode, parameter_range_constraints_reject_incompatible_types) {
auto node = std::make_shared<rclcpp::Node>("test_parameter_range_types"_unq);

rcl_interfaces::msg::ParameterDescriptor integer_range_descriptor;
integer_range_descriptor.integer_range.resize(1);
integer_range_descriptor.integer_range[0].from_value = 0;
integer_range_descriptor.integer_range[0].to_value = 10;
EXPECT_THROW(
node->declare_parameter("bool_with_integer_range", false, integer_range_descriptor),
rclcpp::exceptions::InvalidParameterValueException);
EXPECT_THROW(
node->declare_parameter(
"uninitialized_bool_with_integer_range",
rclcpp::PARAMETER_BOOL,
integer_range_descriptor),
rclcpp::exceptions::InvalidParameterValueException);

rcl_interfaces::msg::ParameterDescriptor floating_point_range_descriptor;
floating_point_range_descriptor.floating_point_range.resize(1);
floating_point_range_descriptor.floating_point_range[0].from_value = 0.0;
floating_point_range_descriptor.floating_point_range[0].to_value = 10.0;
EXPECT_THROW(
node->declare_parameter(
"integer_with_floating_point_range", 1, floating_point_range_descriptor),
rclcpp::exceptions::InvalidParameterValueException);

integer_range_descriptor.dynamic_typing = true;
node->declare_parameter("dynamic_integer_range", 1, integer_range_descriptor);
auto result = node->set_parameter(rclcpp::Parameter("dynamic_integer_range", false));
EXPECT_FALSE(result.successful);
EXPECT_NE(result.reason.find("cannot use integer range constraints"), std::string::npos);
}

TEST_F(TestNode, declare_parameter_with_allow_undeclared_parameters) {
// test cases without initial values
auto node = std::make_shared<rclcpp::Node>(
Expand Down