Macros
class_list_macros.hpp File Reference
#include <class_loader/class_loader.hpp>
Include dependency graph for class_list_macros.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define PLUGINLIB_DECLARE_CLASS(pkg, class_name, class_type, base_class_type)   CLASS_LOADER_REGISTER_CLASS_WITH_MESSAGE(class_type, base_class_type, "pluginlib WARNING: In file " __FILE__ " PLUGINLIB_DECLARE_CLASS is deprecated, please use PLUGINLIB_EXPORT_CLASS instead. You can run the script 'plugin_macro_update' provided with pluginlib in your package source folder to automatically and recursively update legacy macros. Base = base_class_type, Derived = derived_class_type")
 
#define PLUGINLIB_EXPORT_CLASS(class_type, base_class_type)   CLASS_LOADER_REGISTER_CLASS(class_type, base_class_type);
 
#define PLUGINLIB_REGISTER_CLASS(class_name, class_type, base_class_type)   CLASS_LOADER_REGISTER_CLASS_WITH_MESSAGE(class_type, base_class_type, "In file " __FILE__ " pluginlib WARNING: PLUGINLIB_REGISTER_CLASS is deprecated, please use PLUGINLIB_EXPORT_CLASS instead. You can run the script 'plugin_macro_update' provided with pluginlib in your package source folder to automatically and recursively update legacy macros. Base = base_class_type, Derived = derived_class_type")
 

Macro Definition Documentation

#define PLUGINLIB_DECLARE_CLASS (   pkg,
  class_name,
  class_type,
  base_class_type 
)    CLASS_LOADER_REGISTER_CLASS_WITH_MESSAGE(class_type, base_class_type, "pluginlib WARNING: In file " __FILE__ " PLUGINLIB_DECLARE_CLASS is deprecated, please use PLUGINLIB_EXPORT_CLASS instead. You can run the script 'plugin_macro_update' provided with pluginlib in your package source folder to automatically and recursively update legacy macros. Base = base_class_type, Derived = derived_class_type")

This version is the most in use and requires package name in addition to fields in PLUGINLIB_REGISTER_CLASS

Parameters
pkgThe package that exports the plugin (IGNORED AS OF PLUGINLIB 1.9)
class_nameAn alias for the class (no special characters allowed) (IGNORED AS OF PLUGINLIB 1.9)
class_typeThe real class name with namespace qualifier (e.g. Animals::Lion)
base_class_typeThe real base class type from which class_type inherits

Definition at line 60 of file class_list_macros.hpp.

#define PLUGINLIB_EXPORT_CLASS (   class_type,
  base_class_type 
)    CLASS_LOADER_REGISTER_CLASS(class_type, base_class_type);

This version was only made possible with pluginlib 1.9 series. It's the easiest to use and now the official way of exporting classes.

Parameters
class_typeThe real class name with namespace qualifier (e.g. Animals::Lion)
base_class_typeThe real base class type from which class_type inherits

Definition at line 69 of file class_list_macros.hpp.

#define PLUGINLIB_REGISTER_CLASS (   class_name,
  class_type,
  base_class_type 
)    CLASS_LOADER_REGISTER_CLASS_WITH_MESSAGE(class_type, base_class_type, "In file " __FILE__ " pluginlib WARNING: PLUGINLIB_REGISTER_CLASS is deprecated, please use PLUGINLIB_EXPORT_CLASS instead. You can run the script 'plugin_macro_update' provided with pluginlib in your package source folder to automatically and recursively update legacy macros. Base = base_class_type, Derived = derived_class_type")
Parameters
class_nameAn alias for the class (no special characters allowed) (IGNORED AS OF PLUGINLIB 1.9)
class_typeThe real class name with namespace qualifier (e.g. Animals::Lion)
base_class_typeThe real base class type from which class_type inherits
Deprecated:
This version was deprecated in favor of PLUGINLIB_DECLARE_CLASS

Definition at line 49 of file class_list_macros.hpp.



pluginlib
Author(s): Eitan Marder-Eppstein, Tully Foote, Dirk Thomas, Mirza Shah
autogenerated on Mon Jun 4 2018 02:28:17