Ocean::PluginManager::Plugin Class Reference

This class implements a plugin interface. More...

Public Member Functions
	Plugin ()=default
	Creates an empty plugin object.
	Plugin (const std::string &filename, const std::string &name, const std::string &description, const PluginType type, const PluginPriority priority, const PluginTypeSet &dependencySet, const std::string &thirdpartyDependences, const std::string &thirdpartyDescription)
	Creates a new plugin object.
const std::string &	filename () const
	Returns the filename of the plugin.
const std::string &	name () const
	Returns the name of the plugin.
const std::string &	description () const
	Returns the description of the plugin.
const std::string &	thirdpartyInformation () const
	Returns the version information of the used 3rd party libraries.
PluginType	type () const
	Returns the type of this plugin.
const std::string &	thirdpartyDependences () const
	Returns the 3rd party dependences of this plugin.
const std::string &	thirdpartyDescription () const
	Returns the description about the 3rd party dependences of this plugin.
bool	load () const
	Loads the plugin.
bool	loadApple () const
	Loads the plugin (specialization for Apple platforms)
bool	unload () const
	Tries to unload the plugin.
bool	unloadApple () const
	Tries to unload the plugin.
	operator bool () const
	Returns whether the plugin is successfully loaded.
bool	operator< (const Plugin &right) const
	Returns whether the left plugin has to be loaded before the right one.

Protected Types
using	PluginLoadFunction = bool(*)()
	Definition of a function pointer for plugin load functions.
using	PluginUnloadFunction = bool(*)()
	Definition of a function pointer for plugin unload functions.
using	PluginVersionFunction = const char *(*)()
	Definition of a function pointer for plugin version information functions.

Protected Attributes
std::string	filename_
	Filename of the plugin.
std::string	name_
	Name of the plugin.
std::string	description_
	Description of the plugin.
std::string	thirdpartyInformation_
	3rd party library version information.
void *	handle_ = nullptr
	Platform specific plugin handle.
PluginType	type_ = TYPE_UNKNOWN
	Plugin type.
PluginTypeSet	dependencySet_
	Set of plugin types this plugin depends on.
PluginPriority	priority_ = PRIORITY_UNDEFINED
	Load priority of this plugin.
std::string	thirdpartyDependences_
	3rd party dependences.
std::string	thirdpartyDescription_
	3rd party description.
PluginLoadFunction	loadFunction_ = nullptr
	Plugin load function.
PluginUnloadFunction	unloadFunction_ = nullptr
	Plugin unload function.

Detailed Description

This class implements a plugin interface.

Member Typedef Documentation

PluginLoadFunction

using Ocean::PluginManager::Plugin::PluginLoadFunction = bool (*)()

protected

Definition of a function pointer for plugin load functions.

PluginUnloadFunction

using Ocean::PluginManager::Plugin::PluginUnloadFunction = bool (*)()

protected

Definition of a function pointer for plugin unload functions.

PluginVersionFunction

using Ocean::PluginManager::Plugin::PluginVersionFunction = const char* (*)()

protected

Definition of a function pointer for plugin version information functions.

Constructor & Destructor Documentation

Plugin() [1/2]

Ocean::PluginManager::Plugin::Plugin ( )

default

Creates an empty plugin object.

Plugin() [2/2]

Ocean::PluginManager::Plugin::Plugin	(	const std::string &	filename,
		const std::string &	name,
		const std::string &	description,
		const PluginType	type,
		const PluginPriority	priority,
		const PluginTypeSet &	dependencySet,
		const std::string &	thirdpartyDependences,
		const std::string &	thirdpartyDescription
	)

Creates a new plugin object.

Parameters

filename	Plugin filename
name	Plugin name
description	Plugin description
type	Plugin type
priority	Plugin load priority, the higher the priority the earlier the plugin will be loaded
dependencySet	Set of ocean plugin types this plugin depends on.
thirdpartyDependences	3rd party dependences
thirdpartyDescription	3rd party description

Member Function Documentation

description()

const std::string & Ocean::PluginManager::Plugin::description ( ) const

inline

Returns the description of the plugin.

Returns

Plugin description

filename()

const std::string & Ocean::PluginManager::Plugin::filename ( ) const

inline

Returns the filename of the plugin.

Returns

Plugin filename

load()

bool Ocean::PluginManager::Plugin::load

(

)

const

Loads the plugin.

Returns

True, if succeeded

loadApple()

bool Ocean::PluginManager::Plugin::loadApple

(

)

const

Loads the plugin (specialization for Apple platforms)

See also

load()

Returns

True, if succeeded

name()

const std::string & Ocean::PluginManager::Plugin::name ( ) const

inline

Returns the name of the plugin.

Returns

Plugin name

operator bool()

Ocean::PluginManager::Plugin::operator bool ( ) const

explicit

Returns whether the plugin is successfully loaded.

Returns

True, if so

operator<()

bool Ocean::PluginManager::Plugin::operator<

(

const Plugin &

right

)

const

Returns whether the left plugin has to be loaded before the right one.

Parameters

right

Right plugin

Returns

True, if so

thirdpartyDependences()

const std::string & Ocean::PluginManager::Plugin::thirdpartyDependences ( ) const

inline

Returns the 3rd party dependences of this plugin.

Returns

3rd party dependences

thirdpartyDescription()

const std::string & Ocean::PluginManager::Plugin::thirdpartyDescription ( ) const

inline

Returns the description about the 3rd party dependences of this plugin.

Returns

3rd party description

thirdpartyInformation()

const std::string & Ocean::PluginManager::Plugin::thirdpartyInformation ( ) const

inline

Returns the version information of the used 3rd party libraries.

Returns

Version information

type()

PluginManager::PluginType Ocean::PluginManager::Plugin::type ( ) const

inline

Returns the type of this plugin.

Returns

Plugin type

unload()

bool Ocean::PluginManager::Plugin::unload

(

)

const

Tries to unload the plugin.

All resources using this plugin have to be released to unload the plugin.

Returns

True, if succeeded

unloadApple()

bool Ocean::PluginManager::Plugin::unloadApple

(

)

const

Tries to unload the plugin.

(specialization for Apple platforms) All resources using this plugin have to be released to unload the plugin.

See also

unload()

Returns

True, if succeeded

Field Documentation

dependencySet_

PluginTypeSet Ocean::PluginManager::Plugin::dependencySet_

protected

Set of plugin types this plugin depends on.

description_

std::string Ocean::PluginManager::Plugin::description_

protected

Description of the plugin.

filename_

std::string Ocean::PluginManager::Plugin::filename_

protected

Filename of the plugin.

handle_

void* Ocean::PluginManager::Plugin::handle_ = nullptr

mutableprotected

Platform specific plugin handle.

loadFunction_

PluginLoadFunction Ocean::PluginManager::Plugin::loadFunction_ = nullptr

mutableprotected

Plugin load function.

name_

std::string Ocean::PluginManager::Plugin::name_

protected

Name of the plugin.

priority_

PluginPriority Ocean::PluginManager::Plugin::priority_ = PRIORITY_UNDEFINED

protected

Load priority of this plugin.

thirdpartyDependences_

std::string Ocean::PluginManager::Plugin::thirdpartyDependences_

protected

3rd party dependences.

thirdpartyDescription_

std::string Ocean::PluginManager::Plugin::thirdpartyDescription_

protected

3rd party description.

thirdpartyInformation_

std::string Ocean::PluginManager::Plugin::thirdpartyInformation_

protected

3rd party library version information.

type_

PluginType Ocean::PluginManager::Plugin::type_ = TYPE_UNKNOWN

protected

Plugin type.

unloadFunction_

PluginUnloadFunction Ocean::PluginManager::Plugin::unloadFunction_ = nullptr

mutableprotected

Plugin unload function.

---

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

• PluginManager.h