Ignition Gazebo

API Reference

5.1.0
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< SystemPluginPtrLoadPlugin (const sdf::ElementPtr &_sdf)
 Load and instantiate system plugin from an SDF element. More...
 
std::optional< SystemPluginPtrLoadPlugin (const std::string &_filename, const std::string &_name, const sdf::ElementPtr &_sdf)
 Load and instantiate system plugin from name/filename. 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() [1/2]

std::optional<SystemPluginPtr> LoadPlugin ( const sdf::ElementPtr &  _sdf)

Load and instantiate system plugin from an SDF element.

Parameters
[in]_sdfSDF Element describing plugin instance to be loaded.
Returns
Shared pointer to system instance or nullptr.

◆ LoadPlugin() [2/2]

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]_filenameShared library filename to load plugin from.
[in]_nameClass name to be instantiated.
[in]_sdfSDF Element describing plugin instance to be loaded.
Returns
Shared pointer to system instance or nullptr.

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