C++ API

ROS 2 rcl YAML parameter parser

Parse a YAML parameter file and populate the C data structure.

Features are described in detail at http://docs.ros2.org

The data structure params_st will then be used during node initialization

YAML parameter file should follow the yaml syntax shown below

NOTE: It only supports canonical int and float types

<node_namespace_string>:  # optional
  <node1_name>:
    ros__parameters:
      <field_name>: <field_value>
      <parameter_namespace_string>:   # optional
        <field1_name>: <field1_value>
        <field2_name>: <field2_value>
  <node2_name>:
    ros__parameters:
      <field_name>: <field_value>
      <parameter_namespace_string>:   # optional
        <field1_name>: <field1_value>
        <field2_name>: <field2_value>

This package depends on C libyaml.

Quality Declaration

This package claims to be in the Quality Level 1 category, see the Quality Declaration for more details.

Page Hierarchy

• • QUALITY_DECLARATION

Class Hierarchy

• • Struct rcl_bool_array_s
  • Struct rcl_byte_array_s
  • Struct rcl_double_array_s
  • Struct rcl_int64_array_s
  • Struct rcl_node_params_s
  • Struct rcl_params_s
  • Struct rcl_variant_s

File Hierarchy

• • Directory include
    • Directory rcl_yaml_param_parser
      • File parser.h
      • File types.h
      • File visibility_control.h
  • File QUALITY_DECLARATION.md
  • File README.md

Full C++ API

Classes and Structs

• Struct rcl_bool_array_s

• Struct rcl_byte_array_s

• Struct rcl_double_array_s

• Struct rcl_int64_array_s

• Struct rcl_node_params_s

• Struct rcl_params_s

• Struct rcl_variant_s

Functions

• Function rcl_parse_yaml_file

• Function rcl_parse_yaml_value

• Function rcl_yaml_node_struct_copy

• Function rcl_yaml_node_struct_fini

• Function rcl_yaml_node_struct_get

• Function rcl_yaml_node_struct_init

• Function rcl_yaml_node_struct_init_with_capacity

• Function rcl_yaml_node_struct_print

• Function rcl_yaml_node_struct_reallocate

Defines

• Define RCL_YAML_PARAM_PARSER_EXPORT

• Define RCL_YAML_PARAM_PARSER_IMPORT

• Define RCL_YAML_PARAM_PARSER_LOCAL

• Define RCL_YAML_PARAM_PARSER_PUBLIC

• Define RCL_YAML_PARAM_PARSER_PUBLIC_TYPE

Typedefs

• Typedef rcl_bool_array_t

• Typedef rcl_byte_array_t

• Typedef rcl_double_array_t

• Typedef rcl_int64_array_t

• Typedef rcl_node_params_t

• Typedef rcl_params_t

• Typedef rcl_variant_t

Directories

• Directory include

• Directory rcl_yaml_param_parser

Files

• File parser.h

• File QUALITY_DECLARATION.md

• File README.md

• File types.h

• File visibility_control.h

Pages

• QUALITY_DECLARATION