Gazebo Sim

API Reference

8.7.0
SystemLoader Class Reference

Class for loading/unloading System plugins. More...

#include <gz/sim/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< SystemPluginPtrLoadPlugin (const sdf::Plugin &_plugin)
 Load and instantiate system plugin from name/filename. More...
 
std::list< std::stringPluginPaths () 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()

SystemLoader ( )
explicit

Constructor.

◆ ~SystemLoader()

Destructor.

Member Function Documentation

◆ AddSystemPluginPath()

void AddSystemPluginPath ( const std::string _path)

Add path to search for plugins.

Parameters
[in]_pathNew path to be added.

◆ LoadPlugin()

std::optional<SystemPluginPtr> LoadPlugin ( const sdf::Plugin &  _plugin)

Load and instantiate system plugin from name/filename.

Parameters
[in]_pluginSDF Plugin to be loaded.
Returns
Shared pointer to system instance or nullptr.

◆ 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: