Ignition Common

API Reference

4.5.0
PluginInfo Struct Reference

Holds info required to construct a plugin. More...

#include <PluginInfo.hh>

Public Types

using InterfaceCastingMap = std::unordered_map< std::string, std::function< void *(void *)> >
 The keys are the names of the types of interfaces that this plugin provides. The values are functions that convert a void pointer (which actually points to the plugin instance) to another void pointer (which actually points to the location of the interface within the plugin instance). More...
 

Public Attributes

std::function< void(void *)> deleter
 A method that safely deletes an instance of the plugin. More...
 
std::function< void *()> factory
 A method that instantiates a new instance of a plugin. More...
 
InterfaceCastingMap interfaces
 
std::string name
 The name of the plugin. More...
 

Detailed Description

Holds info required to construct a plugin.

Member Typedef Documentation

◆ InterfaceCastingMap

The keys are the names of the types of interfaces that this plugin provides. The values are functions that convert a void pointer (which actually points to the plugin instance) to another void pointer (which actually points to the location of the interface within the plugin instance).

Member Data Documentation

◆ deleter

std::function<void(void*)> deleter

A method that safely deletes an instance of the plugin.

◆ factory

std::function<void*()> factory

A method that instantiates a new instance of a plugin.

◆ interfaces

InterfaceCastingMap interfaces

◆ name

The name of the plugin.


The documentation for this struct was generated from the following file: