ros2plugin.api package

Module contents

ros2plugin.api.get_package_names_with_plugin_resource_types()

Get the names of all packages that register a plugin resource in the ament index.

Returns:

a list of packages exporting plugins.

ros2plugin.api.get_package_plugin_resource(*, package_name=None)

Get all plugin resources registered in the ament index for the given package.

Parameters:

package_name – whose component types are to be retrieved.

Returns:

a list of plugin resources relative path.

ros2plugin.api.get_registered_plugin_resource_list()

Get all plugin resources registered in the ament index.

Returns:

a filtered list containing the plugin ressouce types.

ros2plugin.api.get_registered_plugin_resources()

Get all plugin resources registered in the ament index.

Returns:

a list of (package name, plugin type names) tuples.

ros2plugin.api.is_plugin_resource_type(resource_type)

Check if resource_type has the plugin extension.

Parameters:

resource_type (str) – the resource type name to be evaluated.

Returns:

a boolean, True if resource_type has the plugin extension.