Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

PIAVE::Plugin Class Reference

baseclass for all Plugins More...

#include <plugin.hh>

Inheritance diagram for PIAVE::Plugin:

List of all members.

Public Methods

virtual PluginBasenewElement (const PropertyNode *p=0)=0
 this class serves as a factory for the effect/codec/whatever


Private Attributes

std::string _name
 the name deosn't actually mean much, but helps for debugging and overview

int _priority
 in case more than one plugin fit the requirements of a query the plugin with highest priority is selected.

PluginType_e _type
 in principle the requested properties in a PluginMgr::find() call already determine the plugin type, but this aditional, slightly redundant parameter makes the typecast a little safer.

PropertyNode * _caps
 the capabilites of the plugin.

bool _enabled
 a plugin might be disabled if it has turned out, that is does not work in the current environmen.


Detailed Description

baseclass for all Plugins


Member Data Documentation

PropertyNode* PIAVE::Plugin::_caps [private]
 

the capabilites of the plugin.

When somebody requests a plugin with certain capabilities from the PluginMgr , it is important, that the plugin defines the correct capabilities, so it can be identified.

Todo:
document the minimum capabilities a screen/sound/whatever plugin needs to define

bool PIAVE::Plugin::_enabled [private]
 

a plugin might be disabled if it has turned out, that is does not work in the current environmen.

IEEE1394 might not be available or aRts may not be running etc...


The documentation for this class was generated from the following files:
Generated on Tue Oct 14 20:45:37 2003 for piave by doxygen1.2.18