slr::SlrPlugin::Description Class Reference

#include <SlrPlugin.h>

Inheritance diagram for slr::SlrPlugin::Description:

Public Types
typedef SlrPlugin *(*	PluginBuilder) (void)
	Constructor method definitions used for 'build()' methods in plugins.
Public Types inherited from DD::Image::Description
typedef Node *(*	NodeBuilder) (void *)
typedef std::vector< Description * >	DescriptionList

Public Member Functions
	Description (const char *className, PluginBuilder builder)
	Constructors set name and label to same value.
const char *	pluginClass () const
	Name of the plugin class without any leading pluginPrefix() or trailing pluginSuffix().

Static Public Member Functions
static const Description *	find (const char *className, const char *pluginPrefix=slr::pluginPrefix, const char *pluginSuffix="")

Public Attributes
PluginBuilder	builderFunc
Public Attributes inherited from DD::Image::Description
const char *	compiled
const char *	plugin
License *	license

Static Protected Member Functions
static void	pluginBuilderCallback (DD::Image::Description *desc)

Protected Attributes
const char *	_pluginClass
	Name of plugin class from the ctor - NOT the plugin .so filename!

Additional Inherited Members
Protected Member Functions inherited from DD::Image::Description
void	ctor (void(*f)(Description *))
void	ctor (void(*f)(Description *), NodeBuilder nodeBuilder)

Detailed Description

This structure creates a subclass of an Slr plugin, possibly from loading a plugin file or a compiled-in Description.

Constructor & Destructor Documentation

Description()

slr::SlrPlugin::Description::Description	(	const char *	className,
		PluginBuilder	builder
	)

Constructors set name and label to same value.

Constructor sets name and label to same value.

References DD::Image::Description::compiled, DD::Image::Description::ctor(), DD::Image::Description::license, and pluginBuilderCallback().

Member Function Documentation

pluginBuilderCallback()

void slr::SlrPlugin::Description::pluginBuilderCallback ( DD::Image::Description *  desc )

staticprotected

Method type defined in Description.h: (f)(Description), called when the plugin .so is first loaded. This adds the plugin class to the map of loaded dsos so that we don't need to search or load the .so again.

References pluginClass().

Referenced by Description().

find()

const SlrPlugin::Description * slr::SlrPlugin::Description::find ( const char *  className, const char *  pluginPrefix = slr::pluginPrefix, const char *  pluginSuffix = ""  )

static

Find a dso description by name.

If it has been previously been loaded this method quickly returns an existing cached SlrPlugin::Description, otherwise it prepends SlrPlugin::pluginPrefix() to the start of the name and SlrPlugin::pluginSuffix() to the end of the name (ie 'slrMyCustomIntegrator') before searching the plugin paths for a matching plugin filename.

Returns nullptr if not found.

References DD::Image::plugin_error(), and DD::Image::plugin_load().