C++ API

ament_index_cpp: C++ API to access the ament resource index.

This package contains functions to operate with the resource index

• Get installation prefix of an installed package

  • get_package_prefix()

  • ament_index_cpp/get_package_prefix.hpp

• Get share directory of an installed package

  • get_package_share_directory()

  • ament_index_cpp/get_package_share_directory.hpp

• Get a map of package names to their installation prefix

  • get_packages_with_prefixes()

  • ament_index_cpp/get_packages_with_prefixes.hpp

• Get the content and path of a resource

  • get_resource()

  • ament_index_cpp/get_resource.hpp

• Get a map of resources based on a resource type

  • get_resources()

  • ament_index_cpp/get_resources.hpp

• Check if resource exists and get its path

  • has_resource()

  • ament_index_cpp/has_resource.hpp

• Macros for controlling symbol visibility on the library

  • ament_index_cpp/visibility_control.h

Class Hierarchy

• • Namespace ament_index_cpp
    • Class PackageNotFoundError

File Hierarchy

• • Directory include
    • Directory ament_index_cpp
      • File get_package_prefix.hpp
      • File get_package_share_directory.hpp
      • File get_packages_with_prefixes.hpp
      • File get_resource.hpp
      • File get_resources.hpp
      • File get_search_paths.hpp
      • File has_resource.hpp
      • File visibility_control.h

Full C++ API

Namespaces

• Namespace ament_index_cpp

• Namespace std

Classes and Structs

• Class PackageNotFoundError

Functions

• Function ament_index_cpp::get_package_prefix

• Function ament_index_cpp::get_package_share_directory

• Function ament_index_cpp::get_packages_with_prefixes

• Function ament_index_cpp::get_resource

• Function ament_index_cpp::get_resources

• Function ament_index_cpp::get_search_paths

• Function ament_index_cpp::has_resource

Defines

• Define AMENT_INDEX_CPP_EXPORT

• Define AMENT_INDEX_CPP_IMPORT

• Define AMENT_INDEX_CPP_LOCAL

• Define AMENT_INDEX_CPP_PUBLIC

Directories

• Directory include

• Directory ament_index_cpp

Files

• File get_package_prefix.hpp

• File get_package_share_directory.hpp

• File get_packages_with_prefixes.hpp

• File get_resource.hpp

• File get_resources.hpp

• File get_search_paths.hpp

• File has_resource.hpp

• File visibility_control.h