Skip to content

[WIP] Initialize parameters #477

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

Closed
wants to merge 3 commits into from
Closed
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
4 changes: 4 additions & 0 deletions rclcpp/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ find_package(ament_cmake_ros REQUIRED)
find_package(builtin_interfaces REQUIRED)
find_package(rcl REQUIRED)
find_package(rcl_interfaces REQUIRED)
find_package(rcl_yaml_param_parser REQUIRED)
find_package(rmw REQUIRED)
find_package(rmw_implementation REQUIRED)
find_package(rosgraph_msgs REQUIRED)
Expand Down Expand Up @@ -99,6 +100,7 @@ add_library(${PROJECT_NAME}
# specific order: dependents before dependencies
ament_target_dependencies(${PROJECT_NAME}
"rcl"
"rcl_yaml_param_parser"
"builtin_interfaces"
"rosgraph_msgs"
"rosidl_typesupport_cpp"
Expand All @@ -122,6 +124,8 @@ ament_export_libraries(${PROJECT_NAME})

ament_export_dependencies(ament_cmake)
ament_export_dependencies(rcl)
# TODO(sloretz) Delete this if it doesn't end up being used in an installed header
ament_export_dependencies(rcl_yaml_param_parser)
ament_export_dependencies(builtin_interfaces)
ament_export_dependencies(rosgraph_msgs)
ament_export_dependencies(rosidl_typesupport_cpp)
Expand Down
1 change: 1 addition & 0 deletions rclcpp/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
<build_export_depend>rosidl_typesupport_cpp</build_export_depend>

<depend>rcl</depend>
<depend>rcl_yaml_param_parser</depend>
<depend>rmw_implementation</depend>

<exec_depend>ament_cmake</exec_depend>
Expand Down
155 changes: 155 additions & 0 deletions rclcpp/src/rclcpp/node_interfaces/node_parameters.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
#include <vector>

#include "rcl_interfaces/srv/list_parameters.hpp"
#include "rcl_yaml_param_parser/parser.h"
#include "rclcpp/exceptions.hpp"
#include "rclcpp/create_publisher.hpp"
#include "rcutils/logging_macros.h"
#include "rmw/qos_profiles.h"
Expand Down Expand Up @@ -50,6 +52,159 @@ NodeParameters::NodeParameters(
rmw_qos_profile_parameter_events,
use_intra_process,
allocator);

// Get the node's allocator
const rcl_node_t * node = node_base->get_rcl_node_handle();
if (NULL == node) {
throw std::runtime_error("Need valid node handle in NodeParameters");
}
const rcl_node_options_t * options = rcl_node_get_options(node);
if (NULL == options) {
throw std::runtime_error("Need valid node options NodeParameters");
}

std::vector<std::string> yaml_paths;

// get yaml paths from global arguments
if (options->use_global_arguments) {
const rcl_arguments_t * global_args = rcl_get_global_arguments();
int num_yaml_files = rcl_arguments_get_param_files_count(global_args);
if (num_yaml_files > 0) {
char ** param_files;
rcl_ret_t ret = rcl_arguments_get_param_files(global_args, options->allocator, &param_files);
if (RCL_RET_OK != ret) {
rclcpp::exceptions::throw_from_rcl_error(ret);
}
for (int i = 0; i < num_yaml_files; ++i) {
yaml_paths.emplace_back(param_files[i]);
}
}
}

// get yaml paths from node arguments
int num_yaml_files = rcl_arguments_get_param_files_count(&(options->arguments));
if (num_yaml_files > 0) {
char ** param_files;
rcl_ret_t ret = rcl_arguments_get_param_files(&(options->arguments), options->allocator, &param_files);
if (RCL_RET_OK != ret) {
rclcpp::exceptions::throw_from_rcl_error(ret);
}
for (int i = 0; i < num_yaml_files; ++i) {
yaml_paths.emplace_back(param_files[i]);
}
}

std::vector<rclcpp::parameter::ParameterVariant> parameters;

for (const std::string & yaml_path : yaml_paths) {
// TODO(sloretz) remove when circular dependency between rcl and rcl_yaml_param_parser is solved
rcl_params_t * yaml_params = rcl_yaml_node_struct_init(options->allocator);
if (NULL == yaml_params) {
throw std::runtime_error("Failed to initialize yaml params struct");
}
if (!rcl_parse_yaml_file(yaml_path.c_str(), yaml_params)) {
throw std::runtime_error("Failed to parse parameters " + yaml_path);
}

// Get namespace + node name
const std::string node_name = node_base->get_name();
const std::string node_namespace = node_base->get_namespace();
if (0u == node_namespace.size() || 0u == node_name.size()) {
// Should never happen
throw std::runtime_error("Node name and namespace were not set");
}
std::string combined_name;
if ('/' == node_namespace.at(node_namespace.size() - 1)) {
combined_name = node_namespace + node_name;
} else {
combined_name = node_namespace + '/' + node_name;
}

// TODO(sloretz) should yaml param parser provide node names with a leading slash?
// Strip leading slash
combined_name.erase(combined_name.begin());

// Convert c structs into a list of parameters to set
for (size_t n = 0; n < yaml_params->num_nodes; ++n) {
if (combined_name != yaml_params->node_names[n]) {
continue;
}
const rcl_node_params_t * const params_node = &(yaml_params->params[n]);
for (size_t p = 0; p < params_node->num_params; ++p) {
const std::string param_name = params_node->parameter_names[p];

// If an earlier yaml initialized a parameter with the same name, overwrite it
for (auto iter = parameters.begin(); iter != parameters.end(); ++iter) {
if (param_name == iter->get_name()) {
parameters.erase(iter);
break;
}
}

const rcl_variant_t * const param_value = &(params_node->parameter_values[p]);

if (param_value->bool_value) {
parameters.emplace_back(param_name, *(param_value->bool_value));
} else if (param_value->integer_value) {
parameters.emplace_back(param_name, *(param_value->integer_value));
} else if (param_value->double_value) {
parameters.emplace_back(param_name, *(param_value->double_value));
} else if (param_value->string_value) {
parameters.emplace_back(param_name, std::string(param_value->string_value));
} else if (param_value->byte_array_value) {
const rcl_byte_array_t * const byte_array = param_value->byte_array_value;
std::vector<uint8_t> bytes;
bytes.reserve(byte_array->size);
for (size_t v = 0; v < byte_array->size; ++v) {
bytes.push_back(byte_array->values[v]);
}
parameters.emplace_back(param_name, bytes);
} else if (param_value->bool_array_value) {
const rcl_bool_array_t * const bool_array = param_value->bool_array_value;
std::vector<bool> bools;
bools.reserve(bool_array->size);
for (size_t v = 0; v < bool_array->size; ++v) {
bools.push_back(bool_array->values[v]);
}
parameters.emplace_back(param_name, bools);
} else if (param_value->integer_array_value) {
const rcl_int64_array_t * const int_array = param_value->integer_array_value;
std::vector<int64_t> integers;
integers.reserve(int_array->size);
for (size_t v = 0; v < int_array->size; ++v) {
integers.push_back(int_array->values[v]);
}
parameters.emplace_back(param_name, integers);
} else if (param_value->double_array_value) {
const rcl_double_array_t * const double_array = param_value->double_array_value;
std::vector<double> doubles;
doubles.reserve(double_array->size);
for (size_t v = 0; v < double_array->size; ++v) {
doubles.push_back(double_array->values[v]);
}
parameters.emplace_back(param_name, doubles);
} else if (param_value->string_array_value) {
const rcutils_string_array_t * const string_array = param_value->string_array_value;
std::vector<std::string> strings;
strings.reserve(string_array->size);
for (size_t v = 0; v < string_array->size; ++v) {
strings.emplace_back(string_array->data[v]);
}
parameters.emplace_back(param_name, strings);
} else {
rcl_yaml_node_struct_fini(yaml_params);
throw std::runtime_error("Invalid parameter from parser");
}
}
}
rcl_yaml_node_struct_fini(yaml_params);
}

// Set the parameters
rcl_interfaces::msg::SetParametersResult result = set_parameters_atomically(parameters);
if (!result.successful) {
throw std::runtime_error("Failed to set initial parameters");
}
}

NodeParameters::~NodeParameters()
Expand Down