Pothos  0.4.1-gb758ed46
The Pothos dataflow programming software suite
Public Member Functions | Static Public Member Functions | List of all members
Pothos::PluginModule Class Reference

#include <Module.hpp>

Public Member Functions

 PluginModule (void)
 
 PluginModule (const std::string &path)
 
 ~PluginModule (void)
 Plugin module destructor. More...
 
std::string getFilePath (void) const
 
const std::vector< std::string > & getPluginPaths (void) const
 

Static Public Member Functions

static const PluginModulenull (void)
 A reference to a permanent empty module. More...
 
static PluginModule safeLoad (const std::string &path)
 

Detailed Description

PluginModule represents a loaded shared library in the filesystem.

Constructor & Destructor Documentation

Pothos::PluginModule::PluginModule ( void  )

Create a null PluginModule.

Pothos::PluginModule::PluginModule ( const std::string &  path)

Create a PluginModule from a file path.

Exceptions
PluginPluginModuleErrorif the path does not exist
PluginPluginModuleErrorif the load fails
Parameters
paththe path to a loadable module on the file system
Pothos::PluginModule::~PluginModule ( void  )

Plugin module destructor.

Member Function Documentation

std::string Pothos::PluginModule::getFilePath ( void  ) const

Get a file path for this module.

Returns
the file path for the shared library
const std::vector<std::string>& Pothos::PluginModule::getPluginPaths ( void  ) const

Get the paths that this module loaded into the plugin registry. Each path is a string that represents a path in the registry.

static const PluginModule& Pothos::PluginModule::null ( void  )
static

A reference to a permanent empty module.

static PluginModule Pothos::PluginModule::safeLoad ( const std::string &  path)
static

Test load this libray module within a separate process to avoid loading something destructive within this process. If the test load succeeds, the module will be loaded locally.

Exceptions
PluginPluginModuleErrorif the load fails
Parameters
paththe path to a loadable module on the file system
Returns
the PluginModule loaded at the given file path

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