SystemLoader Class Reference
Class for loading/unloading System plugins. More...
#include <ignition/gazebo/SystemLoader.hh>
Public Member Functions | |
| SystemLoader () | |
| Constructor. More... | |
| ~SystemLoader () | |
| Destructor. More... | |
| void | AddSystemPluginPath (const std::string &_path) |
| Add path to search for plugins. More... | |
| std::optional< SystemPluginPtr > | LoadPlugin (const sdf::ElementPtr &_sdf) |
| Load and instantiate system plugin from an SDF element. More... | |
| std::optional< SystemPluginPtr > | LoadPlugin (const sdf::Plugin &_plugin) |
| Load and instantiate system plugin from name/filename. More... | |
| std::optional< SystemPluginPtr > | LoadPlugin (const std::string &_filename, const std::string &_name, const sdf::ElementPtr &_sdf) |
| Load and instantiate system plugin from name/filename. More... | |
| std::list< std::string > | PluginPaths () const |
| Get the plugin search paths used for loading system plugins. More... | |
| std::string | PrettyStr () const |
| Makes a printable string with info about systems. More... | |
Detailed Description
Class for loading/unloading System plugins.
Constructor & Destructor Documentation
◆ SystemLoader()
|
explicit |
Constructor.
◆ ~SystemLoader()
| ~SystemLoader | ( | ) |
Destructor.
Member Function Documentation
◆ AddSystemPluginPath()
| void AddSystemPluginPath | ( | const std::string & | _path | ) |
Add path to search for plugins.
- Parameters
-
[in] _path New path to be added.
◆ LoadPlugin() [1/3]
| std::optional<SystemPluginPtr> LoadPlugin | ( | const sdf::ElementPtr & | _sdf | ) |
Load and instantiate system plugin from an SDF element.
- Parameters
-
[in] _sdf SDF Element describing plugin instance to be loaded.
- Returns
- Shared pointer to system instance or nullptr.
- Note
- This will be deprecated in Gazebo 7 (Garden), please the use sdf::Plugin interface.
◆ LoadPlugin() [2/3]
| std::optional<SystemPluginPtr> LoadPlugin | ( | const sdf::Plugin & | _plugin | ) |
Load and instantiate system plugin from name/filename.
- Parameters
-
[in] _plugin SDF Plugin to be loaded.
- Returns
- Shared pointer to system instance or nullptr.
◆ LoadPlugin() [3/3]
| std::optional<SystemPluginPtr> LoadPlugin | ( | const std::string & | _filename, |
| const std::string & | _name, | ||
| const sdf::ElementPtr & | _sdf | ||
| ) |
Load and instantiate system plugin from name/filename.
- Parameters
-
[in] _filename Shared library filename to load plugin from. [in] _name Class name to be instantiated. If empty, the first plugin in the shared library will be loaded. [in] _sdf SDF Element describing plugin instance to be loaded.
- Returns
- Shared pointer to system instance or nullptr.
- Note
- This will be deprecated in Gazebo 7 (Garden), please the use sdf::Plugin interface.
◆ PluginPaths()
| std::list<std::string> PluginPaths | ( | ) | const |
Get the plugin search paths used for loading system plugins.
- Returns
- Paths to search for plugins
◆ PrettyStr()
| std::string PrettyStr | ( | ) | const |
Makes a printable string with info about systems.
- Returns
- A pretty string
The documentation for this class was generated from the following file: