MNE-CPP
beta 1.0
|
The IAlgorithm class provides an interface for a real-time algorithm plugin. More...
#include <IAlgorithm.h>
Public Types | |
typedef QSharedPointer< IAlgorithm > | SPtr |
typedef QSharedPointer< const IAlgorithm > | ConstSPtr |
![]() | |
enum | PluginType { _ISensor, _IAlgorithm, _IIO, _PluginSet } |
typedef QSharedPointer< IPlugin > | SPtr |
typedef QSharedPointer< const IPlugin > | ConstSPtr |
typedef QVector< QSharedPointer< PluginInputConnector > > | InputConnectorList |
typedef QVector< QSharedPointer< PluginOutputConnector > > | OutputConnectorList |
Public Member Functions | |
virtual | ~IAlgorithm () |
virtual QSharedPointer< IPlugin > | clone () const =0 |
virtual void | init ()=0 |
virtual void | unload ()=0 |
virtual bool | start ()=0 |
virtual bool | stop ()=0 |
virtual PluginType | getType () const =0 |
virtual QString | getName () const =0 |
virtual bool | multiInstanceAllowed () const |
virtual QWidget * | setupWidget ()=0 |
![]() | |
virtual | ~IPlugin () |
QList< QAction * > | getPluginActions () |
InputConnectorList & | getInputConnectors () |
OutputConnectorList & | getOutputConnectors () |
Protected Member Functions | |
virtual void | run ()=0 |
![]() | |
void | addPluginAction (QAction *pAction) |
Additional Inherited Members | |
![]() | |
InputConnectorList | m_inputConnectors |
OutputConnectorList | m_outputConnectors |
The IAlgorithm class provides an interface for a real-time algorithm plugin.
DECLARE CLASS IAlgorithm
Definition at line 70 of file IAlgorithm.h.
typedef QSharedPointer<const IAlgorithm> MNEX::IAlgorithm::ConstSPtr |
Const shared pointer type for IAlgorithm.
Definition at line 75 of file IAlgorithm.h.
typedef QSharedPointer<IAlgorithm> MNEX::IAlgorithm::SPtr |
Shared pointer type for IAlgorithm.
Definition at line 74 of file IAlgorithm.h.
|
inlinevirtual |
Destroys the IAlgorithm.
Definition at line 81 of file IAlgorithm.h.
|
pure virtual |
Clone the plugin
Implements MNEX::IPlugin.
Implemented in AveragingPlugin::Averaging, NoiseEstimatePlugin::NoiseEstimate, CovariancePlugin::Covariance, TriggerControlPlugin::TriggerControl, MNEPlugin::MNE, RapMusicToolboxPlugin::RapMusicToolbox, and BCIPlugin::BCI.
|
pure virtual |
Returns the plugin name. Pure virtual method inherited by IPlugin.
Implements MNEX::IPlugin.
Implemented in TriggerControlPlugin::TriggerControl, AveragingPlugin::Averaging, MNEPlugin::MNE, BCIPlugin::BCI, RapMusicToolboxPlugin::RapMusicToolbox, NoiseEstimatePlugin::NoiseEstimate, and CovariancePlugin::Covariance.
|
pure virtual |
Returns the plugin type. Pure virtual method inherited by IPlugin.
Implements MNEX::IPlugin.
Implemented in AveragingPlugin::Averaging, MNEPlugin::MNE, TriggerControlPlugin::TriggerControl, BCIPlugin::BCI, RapMusicToolboxPlugin::RapMusicToolbox, NoiseEstimatePlugin::NoiseEstimate, and CovariancePlugin::Covariance.
|
pure virtual |
Initializes the plugin.
Implements MNEX::IPlugin.
Implemented in MNEPlugin::MNE, RapMusicToolboxPlugin::RapMusicToolbox, NoiseEstimatePlugin::NoiseEstimate, BCIPlugin::BCI, AveragingPlugin::Averaging, CovariancePlugin::Covariance, and TriggerControlPlugin::TriggerControl.
|
inlinevirtual |
True if multi instantiation of plugin is allowed.
Implements MNEX::IPlugin.
Definition at line 169 of file IAlgorithm.h.
|
protectedpure virtual |
The starting point for the thread. After calling start(), the newly created thread calls this function. Returning from this method will end the execution of the thread. Pure virtual method inherited by QThread
Implements MNEX::IPlugin.
Implemented in BCIPlugin::BCI, TriggerControlPlugin::TriggerControl, MNEPlugin::MNE, AveragingPlugin::Averaging, RapMusicToolboxPlugin::RapMusicToolbox, RtHpiPlugin::RtHpi, NoiseEstimatePlugin::NoiseEstimate, CovariancePlugin::Covariance, RtSssPlugin::RtSss, and DummyToolboxPlugin::DummyToolbox.
|
pure virtual |
Returns the set up widget for configuration of IAlgorithm. Pure virtual method inherited by IPlugin.
Implements MNEX::IPlugin.
Implemented in AveragingPlugin::Averaging, TriggerControlPlugin::TriggerControl, MNEPlugin::MNE, BCIPlugin::BCI, RapMusicToolboxPlugin::RapMusicToolbox, NoiseEstimatePlugin::NoiseEstimate, and CovariancePlugin::Covariance.
|
pure virtual |
Starts the IAlgorithm. Pure virtual method inherited by IPlugin.
Implements MNEX::IPlugin.
Implemented in AveragingPlugin::Averaging, MNEPlugin::MNE, RapMusicToolboxPlugin::RapMusicToolbox, NoiseEstimatePlugin::NoiseEstimate, BCIPlugin::BCI, CovariancePlugin::Covariance, and TriggerControlPlugin::TriggerControl.
|
pure virtual |
Stops the IAlgorithm. Pure virtual method inherited by IPlugin.
Implements MNEX::IPlugin.
Implemented in AveragingPlugin::Averaging, MNEPlugin::MNE, BCIPlugin::BCI, RapMusicToolboxPlugin::RapMusicToolbox, NoiseEstimatePlugin::NoiseEstimate, TriggerControlPlugin::TriggerControl, and CovariancePlugin::Covariance.
|
pure virtual |
Is called when plugin is detached of the stage. Can be used to safe settings.
Implements MNEX::IPlugin.
Implemented in MNEPlugin::MNE, RapMusicToolboxPlugin::RapMusicToolbox, NoiseEstimatePlugin::NoiseEstimate, BCIPlugin::BCI, AveragingPlugin::Averaging, CovariancePlugin::Covariance, and TriggerControlPlugin::TriggerControl.