RTXI  2.4
The Real-Time eXperiment Interface Documentation
Public Slots | Public Member Functions | Static Public Member Functions | Friends
Plugin::Manager Class Reference

#include <plugin.h>

Inheritance diagram for Plugin::Manager:
Inheritance graph
Collaboration diagram for Plugin::Manager:
Collaboration graph

Public Slots

void customEvent (QEvent *)
 

Public Member Functions

Objectload (const QString &library)
 
void unload (Object *object)
 
void unloadAll (void)
 
void foreachPlugin (void(*callback)(Plugin::Object *, void *), void *param)
 

Static Public Member Functions

static ManagergetInstance (void)
 

Friends

class Object
 

Detailed Description

Provides mechanisms for the loading and unloading of a Plugin::Object

Definition at line 57 of file plugin.h.

Member Function Documentation

◆ customEvent

void Plugin::Manager::customEvent(QEvent * e)
slot

Definition at line 164 of file plugin.cpp.

◆ foreachPlugin()

void Plugin::Manager::foreachPlugin(void(*)(Plugin::Object *, void *) callback,
void * param 
)

Loop through each Plugin and execute a callback. The callback takes two parameters, a Plugin pointer and param, the second parameter to foreachPlugin.

Parameters
callbackThe callback function.
paramA parameter to the callback function.
See also
Plugin::Object

Definition at line 132 of file plugin.cpp.

◆ getInstance()

Plugin::Manager * Plugin::Manager::getInstance(void )
static

Manager is a Singleton, which means that there can only be one instance. This function returns a pointer to that single instance.

Returns
The instance of Manager.

Definition at line 188 of file plugin.cpp.

◆ load()

Plugin::Object * Plugin::Manager::load(const QString & library)

Function for loading a Plugin::Object from a shared library file.

Parameters
libraryThe file name of a shared library.
Returns
A pointer to the newly created Plugin::Object.
See also
Plugin::Object

Definition at line 46 of file plugin.cpp.

◆ unload()

void Plugin::Manager::unload(Plugin::Objectplugin)

Function for unloading a single Plugin::Object in the system.

Parameters
objectThe plugin object to be unloaded.

Definition at line 100 of file plugin.cpp.

Here is the call graph for this function:

◆ unloadAll()

void Plugin::Manager::unloadAll(void )

Function for unloading all Plugin::Object's in the system.

Definition at line 117 of file plugin.cpp.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ Object

friend class Object
friend

Definition at line 62 of file plugin.h.


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