MNE-CPP  beta 1.0
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MNEX::IPlugin Class Referenceabstract

The IPlugin class is the base interface class of all plugins. More...

#include <IPlugin.h>

Inheritance diagram for MNEX::IPlugin:
MNEX::IAlgorithm MNEX::IIO MNEX::ISensor AveragingPlugin::Averaging BCIPlugin::BCI CovariancePlugin::Covariance DummyToolboxPlugin::DummyToolbox MNEPlugin::MNE NoiseEstimatePlugin::NoiseEstimate RapMusicToolboxPlugin::RapMusicToolbox RtHpiPlugin::RtHpi RtSssPlugin::RtSss TriggerControlPlugin::TriggerControl BabyMEGPlugin::BabyMEG ECGSimulatorPlugin::ECGSimulator EEGoSportsPlugin::EEGoSports FiffSimulatorPlugin::FiffSimulator MneRtClientPlugin::Neuromag TMSIPlugin::TMSI

Public Types

enum  PluginType { _ISensor, _IAlgorithm, _IIO, _PluginSet }
 
typedef QSharedPointer< IPluginSPtr
 
typedef QSharedPointer< const IPluginConstSPtr
 
typedef QVector< QSharedPointer< PluginInputConnector > > InputConnectorList
 
typedef QVector< QSharedPointer< PluginOutputConnector > > OutputConnectorList
 

Public Member Functions

virtual ~IPlugin ()
 
virtual QSharedPointer< IPluginclone () const =0
 
virtual void init ()=0
 
virtual void unload ()=0
 
virtual bool start ()=0
 
virtual bool stop ()=0
 
QList< QAction * > getPluginActions ()
 
virtual PluginType getType () const =0
 
virtual QString getName () const =0
 
virtual bool multiInstanceAllowed () const =0
 
virtual QWidget * setupWidget ()=0
 
InputConnectorListgetInputConnectors ()
 
OutputConnectorListgetOutputConnectors ()
 

Protected Member Functions

virtual void run ()=0
 
void addPluginAction (QAction *pAction)
 

Protected Attributes

InputConnectorList m_inputConnectors
 
OutputConnectorList m_outputConnectors
 

Detailed Description

The IPlugin class is the base interface class of all plugins.

DECLARE CLASS IPlugin

Definition at line 92 of file IPlugin.h.

Member Typedef Documentation

typedef QSharedPointer<const IPlugin> MNEX::IPlugin::ConstSPtr

Const shared pointer type for IPlugin.

Definition at line 109 of file IPlugin.h.

typedef QVector< QSharedPointer< PluginInputConnector > > MNEX::IPlugin::InputConnectorList

List of input connectors.

Definition at line 111 of file IPlugin.h.

typedef QVector< QSharedPointer< PluginOutputConnector > > MNEX::IPlugin::OutputConnectorList

List of output connectors.

Definition at line 112 of file IPlugin.h.

typedef QSharedPointer<IPlugin> MNEX::IPlugin::SPtr

Shared pointer type for IPlugin.

Definition at line 108 of file IPlugin.h.

Member Enumeration Documentation

Plugin Type enumeration.

Enumerator
_ISensor 

Type for a sensor plugin.

_IAlgorithm 

Type for a real-time algorithm plugin.

_IIO 

Type for a real-time I/O plugin.

_PluginSet 

Type for a plugin set which holds different types of plugins.

Definition at line 100 of file IPlugin.h.

Constructor & Destructor Documentation

virtual MNEX::IPlugin::~IPlugin ( )
inlinevirtual

Destroys the IPlugin.

Definition at line 118 of file IPlugin.h.

Member Function Documentation

void MNEX::IPlugin::addPluginAction ( QAction *  pAction)
inlineprotected

Adds a plugin action to the current plugin.

Parameters
[in]pActionpointer to the action to be added to the plugin

Definition at line 249 of file IPlugin.h.

virtual QSharedPointer<IPlugin> MNEX::IPlugin::clone ( ) const
pure virtual
virtual QString MNEX::IPlugin::getName ( ) const
pure virtual
QList< QAction * > MNEX::IPlugin::getPluginActions ( )
inline

A list of actions for the current plugin.

Returns
a list of plugin actions

Definition at line 241 of file IPlugin.h.

virtual PluginType MNEX::IPlugin::getType ( ) const
pure virtual
virtual void MNEX::IPlugin::init ( )
pure virtual
bool MNEX::IPlugin::multiInstanceAllowed ( ) const
inlinepure virtual

True if multi instantiation of plugin is allowed.

Returns
true if multi instantiation of plugin is allowed.

Implemented in MNEX::IAlgorithm, and MNEX::ISensor.

Definition at line 233 of file IPlugin.h.

virtual void MNEX::IPlugin::run ( )
protectedpure virtual
virtual QWidget* MNEX::IPlugin::setupWidget ( )
pure virtual
virtual bool MNEX::IPlugin::start ( )
pure virtual
virtual bool MNEX::IPlugin::stop ( )
pure virtual
virtual void MNEX::IPlugin::unload ( )
pure virtual

Member Data Documentation

InputConnectorList MNEX::IPlugin::m_inputConnectors
protected

Set of input connectors associated with this plug-in.

Definition at line 221 of file IPlugin.h.

OutputConnectorList MNEX::IPlugin::m_outputConnectors
protected

Set of output connectors associated with this plug-in.

Definition at line 222 of file IPlugin.h.


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