This class provides the interface to nexuslua "plugins" (agents that are installable from an online repository) More...

#include <plugin_registry.hpp>

Classes
struct	Iterator
	enable iteration over plugins using an instance of PluginsOnline More...

Public Member Functions
	PluginRegistry (const std::shared_ptr< nexuslua::agents > &agents)
	~PluginRegistry ()
PluginInstallResult	Install (std::string name, std::string &strError)
	install the given online plugin; store any errors in strError
std::string	GetErrorMessage ()
	return the last error message
std::shared_ptr< Agent >	Get (const std::string &agentName)
	return the nexuslua::Agent with the given name, provided it is installed as a plugin
std::size_t	Count () const
	return the current number of plugins; depending if RescanInstalled() has been called, this may include plugins that are only available locally
void	RescanInstalled ()
	merge information about the installed plugins with the online plugins; this covers situations where a plugin has been installed that is not available online
Iterator	begin ()
	required to iterator over plugins using a for loop
Iterator	end ()
	required to iterator over plugins using a for loop

Detailed Description

This class provides the interface to nexuslua "plugins" (agents that are installable from an online repository)

Constructor & Destructor Documentation

◆ PluginRegistry()

nexuslua::PluginRegistry::PluginRegistry ( const std::shared_ptr< nexuslua::agents > & agents )

explicit

◆ ~PluginRegistry()

nexuslua::PluginRegistry::~PluginRegistry ( )

Member Function Documentation

◆ begin()

Iterator nexuslua::PluginRegistry::begin ( )

required to iterator over plugins using a for loop

◆ Count()

std::size_t nexuslua::PluginRegistry::Count ( ) const

return the current number of plugins; depending if RescanInstalled() has been called, this may include plugins that are only available locally

◆ end()

Iterator nexuslua::PluginRegistry::end ( )

required to iterator over plugins using a for loop

◆ Get()

std::shared_ptr< Agent > nexuslua::PluginRegistry::Get ( const std::string & agentName )

return the nexuslua::Agent with the given name, provided it is installed as a plugin

◆ GetErrorMessage()

std::string nexuslua::PluginRegistry::GetErrorMessage ( )

return the last error message

◆ Install()

PluginInstallResult nexuslua::PluginRegistry::Install	(	std::string	name,
		std::string &	strError )

install the given online plugin; store any errors in strError

◆ RescanInstalled()

void nexuslua::PluginRegistry::RescanInstalled ( )

merge information about the installed plugins with the online plugins; this covers situations where a plugin has been installed that is not available online

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

src/interface/nexuslua/plugin_registry.hpp

Classes

Public Member Functions