Function fuse_core::list_parameter_override_prefixes

Function Documentation

std::unordered_set<std::string> fuse_core::list_parameter_override_prefixes(node_interfaces::NodeInterfaces<node_interfaces::Parameters> interfaces, std::string prefix)

Get parameter overrides that have a given prefix.

Example: Say the given parameter overrides are foo, foo.baz, foo.bar.baz, and foobar.baz Given prefix “”, this will return foo, and foobar Given prefix “foo”, this will return foo.baz and foo.bar Given prefix “foo.bar”, this will return foo.bar.baz Given prefix “foo.baz”, this will return an empty list

All overrides are searched and returned, so that this can be used to conditionally declare parameters. The returned names may or may not be valid parameters, but instead are prefixes of valid parameters. The prefix itself will never be in the returned output.

Parameters:

  • interfaces – [in] - The node interfaces used to get the parameter overrides

  • prefix – [in] - the parameter prefix

  • max_depth – [in] - how deep to return parameter override names, or 0 for unlimited depth.