RobWorkProject
Public Types | Public Member Functions | Static Public Member Functions | List of all members
ExtensionRegistry Class Reference

an extension point is a class that defines a point where Extension can be added. This is typically used together with plugins, however any class may register extensions to an extension point. More...

#include <ExtensionRegistry.hpp>

Public Types

typedef rw::common::Ptr< ExtensionRegistryPtr
 smart pointer type of ExtensionPoint
 

Public Member Functions

 ExtensionRegistry ()
 Constructor.
 
std::vector< Extension::DescriptorgetExtensionDescriptors (const std::string &ext_point_id) const
 get all descriptors registered for a specific extension point id More...
 
std::vector< rw::common::Ptr< Extension > > getExtensions (const std::string &ext_point_id) const
 get all extensions of a specific extension point More...
 
void registerExtensions (rw::common::Ptr< Plugin > plugin)
 register extensions and extension points of a plugin More...
 
void unregisterExtensions (rw::common::Ptr< Plugin > plugin)
 Unregister extensions and extension points of a plugin. More...
 
void clearExtensions ()
 Unregister all extensions.
 
std::vector< rw::common::Ptr< Plugin > > getPlugins () const
 get a list of registered plugins More...
 

Static Public Member Functions

static rw::common::Ptr< ExtensionRegistrygetInstance ()
 get registry instance
 

Detailed Description

an extension point is a class that defines a point where Extension can be added. This is typically used together with plugins, however any class may register extensions to an extension point.

Member Function Documentation

◆ getExtensionDescriptors()

std::vector<Extension::Descriptor> getExtensionDescriptors ( const std::string &  ext_point_id) const

get all descriptors registered for a specific extension point id

Parameters
ext_point_id[in] identifier of extension point
Returns
list of extension point descriptions

◆ getExtensions()

std::vector<rw::common::Ptr<Extension> > getExtensions ( const std::string &  ext_point_id) const

get all extensions of a specific extension point

Parameters
ext_point_id[in] identifier of extension point
Returns
list of extensions

◆ getPlugins()

std::vector<rw::common::Ptr<Plugin> > getPlugins ( ) const

get a list of registered plugins

Returns
list of plugins

◆ registerExtensions()

void registerExtensions ( rw::common::Ptr< Plugin plugin)

register extensions and extension points of a plugin

Parameters
plugin[in] the plugin that is to be registered

◆ unregisterExtensions()

void unregisterExtensions ( rw::common::Ptr< Plugin plugin)

Unregister extensions and extension points of a plugin.

Parameters
plugin[in] the plugin that is to be removed.

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