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

#include <plugin.h>

Inheritance diagram for Plugin::Object:
Inheritance graph
Collaboration diagram for Plugin::Object:
Collaboration graph

Public Member Functions

 Object (void)
 
virtual ~Object (void)
 
std::string getLibrary (void) const
 
void unload (void)
 
- Public Member Functions inherited from Settings::Object
 Object (void)
 
ID getID (void) const
 
State save (void) const
 
void load (const State &)
 
void deferred (const State &)
 

Friends

class Manager
 

Additional Inherited Members

- Public Types inherited from Settings::Object
typedef unsigned long ID
 
- Static Public Attributes inherited from Settings::Object
const static ID INVALID = 0
 
- Protected Member Functions inherited from Settings::Object
virtual void doLoad (const State &)
 
virtual void doDeferred (const State &)
 
virtual void doSave (State &) const
 

Detailed Description

Provides interface for objects that are loaded from external binaries.

Definition at line 145 of file plugin.h.

Constructor & Destructor Documentation

◆ Object()

Plugin::Object::Object(void )

Definition at line 26 of file plugin.cpp.

Here is the call graph for this function:

◆ ~Object()

Plugin::Object::~Object(void )
virtual

Reimplemented from Settings::Object.

Definition at line 31 of file plugin.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ getLibrary()

std::string Plugin::Object::getLibrary(void )const

Get the name of the library from which the object was loaded.

Returns
The library file the object from which the object was created.

Definition at line 36 of file plugin.cpp.

◆ unload()

void Plugin::Object::unload(void )

A mechanism which an object can use to unload itself. Should only be called from within the GUI thread.

Definition at line 41 of file plugin.cpp.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ Manager

friend class Manager
friend

Definition at line 148 of file plugin.h.


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