Pothos::PluginRegistry Class Reference

#include <Registry.hpp>

Static Public Member Functions
static void	add (const Plugin &plugin)
template<typename ValueType >
static void	add (const PluginPath &path, ValueType &&value)
template<typename CallType >
static void	addCall (const PluginPath &path, const CallType &call)
static Plugin	remove (const PluginPath &path)
static Plugin	get (const PluginPath &path)
static bool	empty (const PluginPath &path)
static bool	exists (const PluginPath &path)
static std::vector< std::string >	list (const PluginPath &path)
static PluginRegistryInfoDump	dump (void)

Detailed Description

PluginRegistry is a singleton class with static access methods.

Member Function Documentation

add() [1/2]

static void Pothos::PluginRegistry::add ( const Plugin &  plugin )

static

Add a plugin to the registry at the specified path.

Parameters

plugin

the plugin to register

add() [2/2]

template<typename ValueType >

void Pothos::PluginRegistry::add ( const PluginPath &  path, ValueType &&  value  )

static

Convenience method to register a new plugin from components.

addCall()

template<typename CallType >

void Pothos::PluginRegistry::addCall ( const PluginPath &  path, const CallType &  call  )

static

Convenience method to register a new callable plugin from components. The second parameter must be a function pointer type. The resulting plugin will contain a Pothos::Callable.

dump()

static PluginRegistryInfoDump Pothos::PluginRegistry::dump ( void  )

static

Create a dump structure of the entire registry.

empty()

static bool Pothos::PluginRegistry::empty ( const PluginPath &  path )

static

Is there nothing located at the given path node? Subtrees may have plugins, but this direct node may not.

Returns

true if the path node is empty

exists()

static bool Pothos::PluginRegistry::exists ( const PluginPath &  path )

static

Does the path exist in the registry?

Returns

true if the path exists

get()

static Plugin Pothos::PluginRegistry::get ( const PluginPath &  path )

static

Get a plugin from the registry at the specified path.

Exceptions

PluginRegistryError

if the path is not in the registry

Parameters

path	the path to the plugin in the registry

Returns

the Plugin at the specified path

list()

static std::vector<std::string> Pothos::PluginRegistry::list ( const PluginPath &  path )

static

List the PluginPath names at the given path. The result will be in the order that the plugins were added.

Parameters

path	the base or directory path

Returns

a list of names in this path

remove()

static Plugin Pothos::PluginRegistry::remove ( const PluginPath &  path )

static

Remove a plugin from the registry at the specified path.

Exceptions

PluginRegistryError

if the path is not in the registry

Parameters

path	the path to the plugin in the registry

Returns

the removed Plugin

---

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

• include/Pothos/Plugin/Registry.hpp